aspiers/git-deps

improve documentation

Open

#69 geöffnet am 10. Feb. 2018

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (55 Forks)github user discovery
documentationhelp wanted

Repository-Metriken

Stars
 (318 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

In #39 @waldyrious made a bunch of excellent suggestions about how to improve the documentation. This issue is for tracking the associated work.

Contributor Guide

Research-Richtung
Überprüfen Sie die Vorschläge in Issue #39 und aktualisieren Sie die Dokumentationsdateien entsprechend. Prüfen Sie die Dokumentationsstruktur und den Styleguide des Projekts.
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.
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80