开源
开源许可证
开源项目内容
- 源代码:包括MOCK数据、SQL文件、配置文件等
- 问答社区:GitHub的Issue、QQ群、微信群等
- 官网:GitHub Pages、独自搭建服务器等;包含以下内容
- 文档 :包括开发环境搭建文档、使用文档/部署文档、二次开发文档等
- dome:产品样例
版本号
版本号规范
版本规范官网:主版本号.子版本号[.修正版本号.编译版本号]
- 主版本号:产品改动较大,可能无法向后兼容(要看具体项目)
- 子版本号:增加了新功能,向后兼容
- 修正版本号:修复BUG或优化代码,向后兼容
- 编译版本号:通常是系统自动生成,每次代码提交都会导致自动加1
版本号修饰词
alpha
: 内部测试版本,BUG 较多,一般用于开发人员内部交流beta
: 测试版,BUG较多,一般用于热心群众测试,并向开发人员反馈rc
: release candidate,即将作为正式版发布,正式版之前的最后一个测试版ga
:general availability,首次发行的稳定版r
/release
/或不加:最终释放版,用于一般用户lts
: 长期维护版,官方会指定对这个版本维护到哪一年,会修复所有在这个版本中发现的BUG
版本号管理策略
- 项目初始版本号可以是0.1或1.0
- 项目进行BUG修正时,修正版本号加1
- 项目增加部分功能时,子版本号加1,修正版本号复位为0
- 项目有重大修改时,主版本号加1
- 编译版本号一般是编译器在编译过程中自动生成的,只需要定义格式,并不需要人为控制
开源项目规目录
可看情况进行增加或删减
README.md
:项目自述文件.editorconfig
:代码规范配置文件,配置编辑器的换行、缩进存储格式.gitignore
:忽略上传GitHub的文件配置LICENSE
:开源许可证文件ChangeLog.md
:更新日志文件src
:源代码test
:单元测试用例doc
:文档example
:示例release
:发布结果
Comments NOTHING