cookiecutter/cookiecutter-django

Document each feature of this project

開放

#567 建立於 2016年6月2日

 (5 則留言) (0 個反應) (0 位負責人)Python (3,064 個分叉)batch import
docshelp wantedhigh priority

倉庫指標

星標
 (13,592 顆星)
PR 合併指標
 (平均合併 16小時 37分鐘) (30 天內合併 59 個 PR)

描述

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.

貢獻者指南