e-m-b-a/emba

Improve module documentation

Aberta

#1.844 aberto em 8 de jan. de 2026

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Shell (314 forks)auto 404
EMBAdocumentationenhancementgood first issuehelp wantedstale

Métricas do repositório

Stars
 (3.565 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Is your feature request related to a problem? Please describe. We started to implement some further module documentation a while ago. To move on with documentation improvements further community support would be highly appreciate.

Describe the solution you'd like A template module with some notes on the documentation is available here https://github.com/e-m-b-a/emba/blob/5cbdc191f4c19707dcec47d5652b7862b20a8a03/modules/template_module.sh#L34

Another module with implemented docs can be found here: https://github.com/e-m-b-a/emba/blob/master/modules/S04_windows_basic_analysis.sh

Guia do colaborador

Direção de pesquisa
Siga o módulo de modelo (template module.sh) e o exemplo (S04 windows basic analysis.sh) para adicionar documentação a um módulo existente. Certifique se de incluir descrição, autor e notas conforme o modelo.
Pilha de tecnologia
shell
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90