e-m-b-a/emba

Improve module documentation

Aperta

#1844 aperta il 8 gen 2026

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Shell (314 fork)auto 404
EMBAdocumentationenhancementgood first issuehelp wantedstale

Metriche repository

Star
 (3565 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Segui il modulo template (template module.sh) e l'esempio (S04 windows basic analysis.sh) per aggiungere documentazione a un modulo esistente. Assicurati di includere descrizione, autore e note come da template.
Tech stack
shell
Dominio
documentationbackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90