Git commit规范 & changelog

296 阅读1分钟

git commit 提交格式要求

良好的Git commit规范优势

  • 加速code review速度
  • 根据Git commit的元数据生成Changelog
  • 便于后续维护者维护,了解code修改原因

提交的格式要求

<type>(<scope>): <subject>
blank line 
<main body>
blank line 
<footer>

example: fix(personal): portrait img update

type代表某次提交的类型,比如是修复个bug还是增加个新的feature,所有的type类型如下:

  • feat: 新增 feature
  • fix: 修复bug
  • docs: 仅仅修改了文档,比如 README, CHANGELOG, CONTRIBUTE等等
  • style: 仅仅修改了空格、格式缩进、都好等等,不改变代码
  • refactor: 代码重构,没有加新功能或者修复bug
  • perf: 优化相关,比如提升性能、体验
  • test: 测试用例,包括单元试、集成试等
  • chore: 改变构建流程、或者增加依赖库、工具等
  • revert:回滚到上一个版本