为开源做贡献，github 发布项目时的结构化仓库模板

• 前言

工作中经常会写一些小工具，不管是内部还是外部，都想用通用的方式发布出去，这样别人就能使用，不用再“重复造轮子”。
这里以 python 为例，介绍项目中的一些使用习惯，方便其他人理解、使用

• 仓库模板

https://github.com/Witee/project-template

• 目录介绍

  1. docs/ : 放置参考文档
  2. myPkgName/ : 真正的包目录
  3. tests/ : 测试本项目的测试脚本目录

• 文件介绍

  1. README.md : 使用 markdown 语法介绍本项目的情况
  2. setup.py : 本项目如何安装到系统中
  3. .gitignore : git 中忽略的文件
  4. 可选的文件：
     • requirements.txt
     • Makefile
     • LICENSE

• 说明
  通过以上的目录及文件，用户就可以明白它们的作用，快速的使用你的项目。

• 注意
  setup.py 中是将项目路径写入 .pth 文件中实现 python 可以搜索到的。