e-m-b-a/emba

Improve module documentation

Offen

#1.844 geöffnet am 08.01.2026

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Shell (314 Forks)auto 404
EMBAdocumentationenhancementgood first issuehelp wantedstale

Repository-Metriken

Stars
 (3.565 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Befolgen Sie das Vorlagenmodul (template module.sh) und das Beispiel (S04 windows basic analysis.sh), um einem vorhandenen Modul eine Dokumentation hinzuzufügen. Stellen Sie sicher, dass Sie Beschreibung, Autor und Hinweise gemäß der Vorlage aufnehmen.
Tech Stack
shell
Domain
documentationbackend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90