guyzmo/git-repo

Write more thorough documentation

Ouverte

#146 ouverte le 21 mars 2017

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Python (91 forks)batch import
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (854 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

  • 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

Guide contributeur

Direction de recherche
Apprenez l'outil de documentation Sphinx, explorez la structure du projet et commencez à rédiger la documentation sur l'utilisation et les détails internes, puis téléchargez la sur ReadTheDocs.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75