donnemartin/gitsome

Provide man pages

Offen

#62 geöffnet am 08.06.2016

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (443 Forks)batch import
feature-requesthelp wanted

Repository-Metriken

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

Beschreibung

At the moment help can be got through --help. This is fine but not quite as intuitive as it could be: it is customary, that help can also be invoked though gh help|--help|-h <command>, gh <command> --help|-h and man gh <command>. Usually also man pages are used as default, so that using the help commands or switches would merely open the man page.

Contributor Guide

Research-Richtung
Untersuche die aktuelle help Ausgabe und erstelle Manpages mit einem Tool wie argparse manpage oder manuell. Aktualisiere das Build Skript, um die Manpages zu installieren.
Tech Stack
python
Domain
clidocumentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75