-
非编码类规范
- 开源规范
- 文档规范
- 版本规范
- Commit规范
- 开发流程规范
- 发布规范
-
编码类规范
- 目录规范
- 代码规范
- 接口规范
- 日志规范
- 错误码规范
开源协议的各种规范，各种限制看这张图就足够了。
下面是项目，特别是开源项目，需要具备的规范。
- 项目结构合理
- 严格遵守代码规范，比如变量的命名，
- 代码的质量：比如良好的算法，运用得当的设计模式，合理的代码长度
- 单元测试覆盖率要高
- 版本发布要规范，遵守版本的标号，例如 v1.1.3 ， 要有版本号文件，通常是 CHANGELOG.md
- 向下兼容，高版本要兼容低版本的东西
- 详细的文档说明
- 安全的代码，不要出现涉密的内容，比如内部的密码等
- 完善的example，好的example胜过文档说明
- 良好的Commit 提交规范
- 保证项目的可用性，每一个版本都要经过严格的测试才能放出来
- 及时处理 requests
- 做好推广以及讨论小组
- 遵守git规范