cookiecutter/cookiecutter-django

Document each feature of this project

Open

#567 创建于 2016年6月2日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Python (10,896 star) (2,713 fork)batch import
docshelp wantedhigh priority

描述

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.

贡献者指南

技术栈
pythondjango
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
DjangoreStructuredText
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.