在一个项目的开发周期内， 如何优雅的编写代码至关重要， 但是一个良好的代码仓库也是必不可少的。
你需要合理的安排你的文件，你的目录，可以非常清楚的让别人知道你的项目的名称，作用以及结构。
仓库样例
由Kenneth Reitz 推荐的仓库样例 samplemod。
samplemod
1. readme
对项目的整体介绍，同时也是一份使用手册，需要时常维护更新。
通常为README.rst/README.md
2. sample
这个是核心代码的存放区， 取一个简单易懂的名字。
3. setup.py
通过setup把核心代码打包发布
4. requirements.txt
存放该项目所有依赖的第三方库， 可以让其他developer可以通过pip快速安装所需开发环境
5. license
阐述该项目的许可说明和授权， 详见choosealicense.com
6. makefile
用于项目的命令管理， 例如 make test/ make dep, 开源项目广泛使用。
7. tests
所有的代码测试都归拢于该目录
8. docs
存放一些文件及其他数据
9. 其他
根据项目的需求增加其他的文件或目录
网友评论