Commit 提交规范

438 阅读1分钟

养成良好的提交规范更有助于团队建设的交流合作,尤其是在提交了很多代码之后回头看一下自己的提交记录会很有成就感和丝滑流畅感

遵守 Angular 规范 提交 commit,history 看起来更加清晰:

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
  • type 提交 commit 的类型,包括以下几种:

  • feat : 新功能

  • fix : 修复问题

  • docs : 修改文档

  • style : 修改代码格式,不影响代码逻辑

  • refactor : 重构代码,理论上不影响现有功能

  • perf : 提升性能

  • test : 增加修改测试用例

  • chore : 修改工具相关(包括但不限于文档、代码生成等)

  • deps : 升级依赖

  • subject 用一句话清楚的描述这次提交做了什么

  • body 补充 subject,适当增加原因、目的等相关因素,也可不写

  • footer

  • 当有非兼容修改(Breaking Change)时必须在这里描述清楚

  • 关联相关 issue,如 Closes #1, Closes #2, #3

  • 如果功能点有新增或修改的,还需要关联文档 docegg-init 的 PR,如 eggjs/egg-bin#123

PS:
如今我总是为了享受一下书写 pref 时的那种短暂自豪感儿疯狂优化代码~~hiahiahia😄