title: GitHub上开源一个软件，一般需要遵行哪些目录与文件规范？
desc: GitHub 上的开源软件通常都有很多共通的目录和文件。<br><br>比如 README.mdLICENCE，还有 doc 文件夹，这似乎并不是个强制的规范，而且比较新的项目都有 dockerfile ，其他文件夹和文件配置按照各种语言特性也都略有不同。<br><br>那么一般常见的开源软件发布比较通行目录规范都有哪些呢？
topic: 开源软件
content: 同意 Belleve 的规范，这里再补充一些。1. 如果你在项目根目录放一个CONTRIBUTING.md，里面的内容是提醒别人为这个项目做贡献的时候，应该使用的流程。在别人pull request的时候，就会自动提示这个文件。比如这个 python-cmake-buildsystemCONTRIBUTING.md at master gongminminpython-cmake-buildsystem GitHub 2. 编译器和IDE自动生成的文件，不该放入git。这是初学者常犯的错误。那些文件只存在于本地，通过放入.gi
answerer_tags: http://klayge.org