GitHub 开源一个项目的基本规范

1、项目结构与代码规范

2、使用主流的包管理器，让你的项目可以非常容易的与其他项目合并

3、严格的单元测试及持续集成；是否有单元测试是一个项目是否靠谱的重要评估标准，单元测试的覆盖度，也能够说明项目是否严谨；持续集成功能能够让用户直观的看到项目质量。酱紫用户才会放心使用

4、要有大致的ROADMAP，开源项目是给别人用的，严格线路规划能够避免项目的变化，对用户更友好

5、版本控制，语义化版本 2.0.0

6、完善的examples，让用户快速学习项目的使用方法

7、完善的文档（英文），如果有精力可以同时维护英文、中文两份文档

8、README.MD中需要添加travis-ci等tag图标

9、如有精力可以搭建项目官网

10、明确的作者联系渠道

原文链接： https://www.zhihu.com/question/22195970