cookiecutter/cookiecutter-django

Document each feature of this project

Open

Aperta il 2 giu 2016

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)Python (10.896 star) (2713 fork)batch import
docshelp wantedhigh priority

Descrizione

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.

Guida contributor

Tech stack
pythondjango
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
DjangoreStructuredText
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
Identify the features listed in the README of the cookiecutter django project. For each feature, create a .rst file in the docs/ directory. Document what users should know, default configuration, and relevant options. Use TODOs for incomplete sections. The README is at https://github.com/cookiecutter/cookiecutter django.