Commit规范

Stitch-Zhang

Stitch-Zhang

An iddle programer

Git Commit规范#

合格的commit能够以精炼的言语对每次提交的代码做出总结,辅助开发者理解项目进度,流程。

Example#

feat: allow overriding of webpack config
^--^ ^------------^
| |
| +-> 简要概括修改/新增/删除/更新的文件
|
+-------> 类型: chore, docs, feat, fix, refactor, style, or test.

名词解释#

  • feat: 新增功能/逻辑
  • fix: 修复bug
  • docs: 对文档的增删
  • style: 代码文件格式化
  • refactor: 重构,如更改逻辑、更改变量名/函数/方法名
  • test: 添加对函数/方法/逻辑的单元测试
  • chore: 其他 blog.stitch-zhang.vercel.app

优秀的commit#

Docusaurus Moby Project logo Moby Moby Project logo excellet