一、开发时必须从最新代码上拉取功能分支,以分支-用户-功能为新的分支名
结构:xxx-xxx-xxx
例子:dev-aimee-user-create
二、提交分支时注明:动作类型(新增、修改、删除、重构)+用户故事+改动明细,禁止填写无意义或不相关的注明;
结构:【xxx】(xxx)xxxxx
例子:【feat】(用户新增): 新增用户
【type】(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
扫描二维码关注公众号,回复:
9303662 查看本文章
type必填
- feat: 添加新特性
- fix: 修复bug
- docs: 仅仅修改了文档
- style: 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
- refactor: 代码重构,没有加新功能或者修复bug
- perf: 优化相关,比如提升性能、体验
- test: 增加测试用例
- chore: 改变构建流程、或者增加依赖库、工具等
- revert: 回滚到上一个版本
scope非必填(建议填写)
scope用于说明 commit 影响的范围,建议填写影响的功能模块。如果你的修改影响了不止一个scope,你可以使用*代替。
subject 必填
commit 目的的简短描述,不超过50个字符。 以动词开头,结尾不加句号 body 非必填(建议填写) 可描述当前修改的行为详细信息或修改的目的。
footer非必填
一般用于描述BREAKING CHANGE,在项目开发中一般不需要填写,组件研发的工程需要填写。后面是对变动的描述、以及变动理由和迁移方法。