cookiecutter/cookiecutter-django

Document each feature of this project

Ouverte

#567 ouverte le 2 juin 2016

Voir sur GitHubGuide contributeur
 (5 commentaires) (0 réaction) (0 personne assignée)Python (3 067 forks)batch import
docshelp wantedhigh priority

Métriques du dépôt

Stars
 (13 602 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

It would be nice if each feature listed in README had its own .rst file in docs/ with detailed documentation explaining:

  • What users should know about it
  • How it is configured by default in Cookiecutter Django
  • Which options correspond to or affect it, if any

More than one person can work on this at a time -- just comment with which part you are working on.

If you don't understand everything about a particular feature, that's OK. Just document what you can and leave TODOs where you want others to help out.

Guide contributeur

Direction de recherche
Lisez le README et vérifiez la structure du répertoire docs/ existant, puis choisissez une fonctionnalité dans la liste et rédigez un fichier .rst en suivant les exemples existants.
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90