guyzmo/git-repo

Write more thorough documentation

Open

#146 geöffnet am 21. März 2017

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (86 Forks)batch import
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (837 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

Contributor Guide

Research-Richtung
Richten Sie die Sphinx Dokumentationsstruktur im Projekt ein, erstellen Sie ein geeignetes Benutzerhandbuch und eine Manpage, dokumentieren Sie die internen Abläufe und konfigurieren Sie die Read the Docs Integration. Beziehen Sie sich auf die Struktur und den Inhalt der Dokumentation ähnlicher Python Projekte.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70