cookiecutter/cookiecutter-django

Document each feature of this project

Open

#567 opened on 2016年6月2日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Python (2,713 forks)batch import
docshelp wantedhigh priority

Repository metrics

Stars
 (10,896 stars)
PR merge metrics
 (平均マージ 16h 37m) (30d で 59 merged PRs)

説明

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.

コントリビューターガイド