ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

commit message格式规范

2020-10-09 08:32:39  阅读:283  来源: 互联网

标签:git 修复 fix 提交 格式 commit message


综合阿里巴巴和高德地图相关部门已有的规范总结的git commit规范(转载)

<type>(<scope>): <subject>

type(必须)

用于说明git commit的类别,只允许使用下面的标识。

  1. feat:新功能(feature)。

  2. fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

    • fix:产生diff并自动修复此问题。适合于一次提交直接修复问题

    • to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix

  3. docs:文档(documentation)。

  4. style:格式(不影响代码运行的变动)。

  5. refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

  6. perf:优化相关,比如提升性能、体验。

  7. test:增加测试。

  8. chore:构建过程或辅助工具的变动。

  9. revert:回滚到上一个版本。

  10. merge:代码合并。

  11. sync:同步主线或分支的Bug。

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject(必须)

subject是commit目的的简短描述,不超过50个字符。

  • 建议使用中文(感觉中国人用中文描述问题能更清楚一些)。
  • 结尾不加句号或其他标点符号。

根据以上规范git commit message将是如下的格式

fix(DAO):用户查询缺少username属性 

feat(Controller):用户查询接口开发

这样规范git commit到底有哪些好处呢?

  • 便于程序员对提交历史进行追溯,了解发生了什么情况。

  • 一旦约束了commit message,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。

  • 格式化的commit message才可以用于自动化输出Change log。

标签:git,修复,fix,提交,格式,commit,message
来源: https://www.cnblogs.com/zhouqx979/p/13783425.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有