cookiecutter/cookiecutter-django

Document each feature of this project

Offen

#567 geöffnet am 02.06.2016

Auf GitHub ansehenContributor Guide
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (3.064 Forks)batch import
docshelp wantedhigh priority

Repository-Metriken

Stars
 (13.592 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16h 37m) (59 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Lies die README und überprüfe die vorhandene docs/ Verzeichnisstruktur, wähle dann eine Funktion aus der Liste aus und schreibe eine .rst Datei nach vorhandenen Beispielen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
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
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90