git分支的命名和使用
1.1、开发分支
命名格式:feature/{feature_name}
不得在master分支上开发。开发分支主要用于开发与测试验证
说明
feature:固定目录前缀
feature_name:对应版本,参考版本规范;或其他有意义的名称。
使用场景
开发分支只在项目(开发)环境中发布,在项目(开发)环境完成测试后,合并入 release 分支,在稳定环境发布
1.2、发布分支
命名格式: release/{release_name}
发布分支上的代码是至少完成过一轮测试的稳定代码
说明
release:固定目录前缀
release_name:ci 或 版本名称
CI分支:release/ci
CI分支上的代码是最新、且经过测试的代码,同时会定期执行自动化测试,已保障CI分支的代码质量。
发布分支:release/{release_name}
发布分支是稳定待发布分支,
使用场景
release分支的创建,意味着项目代码趋于稳定,是可以随时准备发布的代码;
1.3、bug修复分支
命名格式: hotfix/{release_name}
bug修复分支上的代码是用于发布生产后用于紧急修复时发布的分支
说明
hotfix:固定目录前缀
hotfix_name:对应版本,参考版本规范;或其他有意义的名称。
使用场景
bug修复分支是在项目发布上线后,发现了需要紧急修复的bug后紧急修复所发布的分支,在项目(开发)环境完成测试后,合并入 release 分支,在稳定环境发布
1.4、命名规范
总的格式 xxx上线日期花名
- xxx表示的是项目或迭代的名称,一般用英文小写表示,比较长的话,可以考虑缩写
- 多人开发的话建议带上花名,这样在删分支的时候可以自己删除自己的,或者让其他人方便的找到自己。合并分支就没有带花名
2、标签
命名规范: {release_name}
说明 relase_name 版本名称(命名和release分支保持一致,去掉固定目录前缀即可)命名创建标签。
使用场景
代码正式发布后,根据版本名称创建标签
3、分支使用规范
- 不用的分支要尽快删除,不同类型的分支数量建议feature不超过5个、release不超过3个
- 可以删除标签,前提是版本必须是从未对外发布过的版本,或极小范围内发布并通知、确认使用方已经弃用的情况下。同时,最后需要删除私库上已上传的版本。
4、代码提交规范
Git 每次提交代码,都要写 Commit message(提交说明)
$ git commit -m "hello world"
上面代码的-m 参数,就是用来指定 commit mesage 的。
如果一行不够,可以只执行git commit,就会跳出文本编辑器,让你写多行.
$ git commit
Commit message 的格式
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
<Header>
<Body>
<Footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
Header
Header 部分只有一行,包括三个字段:type(必需)、scope(可选)、subject(必需)。
<type>(<scope>): <subject>
type
type 用于说明 commit 的类别,只允许使用下面 7 个标识。
- feat:新功能(feature)
- fix:修补 bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
subject
subject 是 commit 目的的简短描述,不超过 50 个字符。
以动词开头,使用第一人称现在时,比如 change,而不是 changed 或 changes
第一个字母小写
结尾不加句号(.)
Body
Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Use a hanging indent
有两个注意点
- 使用第一人称现在时,比如使用 change 而不是 changed 或 changes。
- 应该说明代码变动的动机,以及与以前行为的对比。
Footer
Footer 部分只用于两种情况:
- 关联 Issue
- 关闭 Issue
关联 Issue
本次提交如果和摸个 issue 有关系则需要写上这个,格式如下:
Issue #1, #2, #3
关闭 Issue
如果当前提交信息解决了某个 issue,那么可以在 Footer 部分关闭这个 issue,关闭的格式如下:
Close #1, #2, #3
Revert
还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option
is reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body 部分的格式是固定的,必须写成 This reverts commit
如果当前 commit 与被撤销的 commit在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面。
例子
feat: 添加了分享功能
给每篇博文添加了分享功能
- 添加分享到微博功能
- 添加分享到微信功能
- 添加分享到朋友圈功能
Issue #1, #2
Close #1