cookiecutter/cookiecutter-django

Document each feature of this project

Open

#567 aperta il 2 giu 2016

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

Metriche repository

Star
 (10.896 star)
Metriche merge PR
 (Merge medio 16h 37m) (59 PR mergiate in 30 g)

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

Direzione di ricerca
Leggi il README e controlla la struttura della directory docs/ esistente, poi scegli una funzionalità dall'elenco e scrivi un file .rst seguendo gli esempi esistenti.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90