aRustyDev / aRustyDev/dotfiles

Docs: Module Documentation Standards

Offen
#46 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Jupyter Notebook
Sterne
1
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Define documentation requirements

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

In dem Issue werden keine Dateien, Tests oder Einstiegspunkte genannt; kläre zunächst, welche Module und welcher Dokumentationsort im Umfang liegen. Als abgeschlossen gilt die schriftliche Festhaltung eines vereinbarten Satzes von Anforderungen an die Moduldokumentation, aber das Issue definiert weder diese Anforderungen noch einen Validierungsschritt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.