文章目录
一 开发规范
1 分支命名规范
| 名称 | 说明 | 命名规范 | 命名示例 | 目标 | 合并操作 |
|---|---|---|---|---|---|
| master | 线上稳定版本，发布需要打Tag。 | master | master | – | – |
| test | 测试分支，待发布版本。 | test | test | master | merge request |
| dev | 当前正在开发的分支 | dev | dev | test | merge request |
| feature | 功能分支，每个功能需分别建立自己的子分支 | feature-功能模块 | feature-order | dev | merge request |
2 CommitMessage 规范
Git提交代码必须输入commit message，否则不允许提交。commit message应该尽量清晰明了，说明本次提交的目的。关于commit message写法规范，我们将采用社区使用最广的angular规范，比较合理和系统化，并且有配套的工具。
commit message格式
每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
Header
(1) type
type用于说明commit的类别，常用的标识如下：
- feat：新功能
- fix：修补bug
- docs：文档
- style： 格式（不影响代码运行的变动,空格,格式化,等等）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动)
- perf: 性能 (提高代码性能的改变)
- test：增加测试或者修改测试
- build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
- ci: 对CI配置文件和脚本的更改
- chore：对非 src 和 test 目录的修改
- revert: Revert a commit
(2) scope
scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
(3) subject
subject是 commit 目的的简短描述，不超过50个字符，主要介绍此次代码变更的主要内容。
Body
Body 部分是对本次 commit 的详细描述，可以分成多行。
例如：
-修改菜单查询接口
-增加菜单删除接口
日常项目开发中，如果Header中subject已经描述清楚此次代码变更的内容后，Body部分就可以为空。
Footer
(1) 不兼容变动
(2) 关闭 Issue
日常项目中开发，Footer不常用，可为空。
最低0.47元/天 解锁文章
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
