一个良好的项目目录结构

e00f05baedca2dfade3a181596d958b1_b.png

build/ 构建脚本
dist/ 编译出来的发布版
docs/ 文档
examples/ 示例文件（如果你写的是库的话）
src/ 源码
test/ 测试脚本
.babelrc Babel 交叉编译的配置
.eslintrc ESLint 测试配置
**LICENSE **授权协议
**README.md **自述文件，里面至少得写：
项目的特色
各种 Badge 比如 CI 的
下载安装
示例运行/使用
怎么编译（尤其 C/C++，要把编译器、要装什么工具、依赖库全部写清楚。要带版本号！）
怎么参与

circle.yml Circle CI 持续集成配置文件（当然你可能用别的 CI，名字会变。比如我那个 otfcc 使用了两个 CI：Travis 和 Appveyor，就写了两个配置）
bower.json Bower 包管理器配置文件
package.json npm 包管理器配置文件
作者：Belleve链接：https://www.zhihu.com/question/48019650/answer/109951418来源：知乎著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

1.有文档说明2.有开源协议著名并遵守其要求3.写好每次commit的说明注释4.有人看着issue和pr，别完全不鸟5.代码格式、命名什么的遵循一定规范6.对于在线项目尽可能提供点儿例子7.有稳定版本请提供release