e-m-b-a/emba

Improve module documentation

Ouverte

#1 844 ouverte le 8 janv. 2026

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Shell (314 forks)auto 404
EMBAdocumentationenhancementgood first issuehelp wantedstale

Métriques du dépôt

Stars
 (3 565 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Suivez le module modèle (template module.sh) et l'exemple (S04 windows basic analysis.sh) pour ajouter de la documentation à un module existant. Assurez vous d'inclure la description, l'auteur et les notes selon le modèle.
Stack technique
shell
Domaine
documentationbackend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90