commit message规范

commit message规范

简述:

每次本地代码改动提交到远程,需要注明提交说明,否则不允许提交到远程。

每次提交,包括三个部分: header, body, footer

<type>(<scope>): <subject> // 必须

                <body> // 可选

                <footer> // 可选

解释:

  • type: 提交类别(下面基本会覆盖提交代码所需,建议只出现下面的类别,多了会更乱)
    1. init:初始化
    2. feat:新功能(feature)
    3. fix:修补bug
    4. docs:文档(documentation)
    5. style: 格式(不影响代码运行的变动)
    6. refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    7. test:增加测试
    8. chore:构建过程或辅助工具的变动
  • scope:影响范围(可不写)
  • subject:对改变的正常描述,最好以动词开头语(尽量详细,必填)
  • body:详细描述
  • footer:修改不兼容变动以及关闭Issue时

工具(Commitizen)

安装:

npm install -g commitizen

在项目目录里运行

commitizen init cz-conventional-changelog --save --save-exact

git commit命令就换成git cz

这样会自动提示以上几个类别

猜你喜欢

转载自www.cnblogs.com/zyk-cn/p/12182908.html