前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >commit规范

commit规范

作者头像
lonelydawn
发布2022-07-04 08:07:48
4760
发布2022-07-04 08:07:48
举报

使用 git 管理的代码库,若在提交时能保持一定的格式,则能使维护者一眼看懂每次提交的目的和含义。除了注释之外,我们还可以在提交时加一些标识进行说明。

代码语言:javascript
复制
<type>(<scope>): <subject>

其中:

type 可选:

  • feat:新功能(feature)
  • fix/to:修复bug,可以是 QA 发现的 BUG,也可以是研发自己发现的 BUG。
    • fix:产生 diff 并自动修复此问题。适合于一次提交直接修复问题
    • to:只产生 diff 不自动修复此问题。适合于多次提交。最终修复问题提交时使用 fix
  • docs:文档(documentation)
  • style:格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
  • perf:优化相关,比如提升性能、体验。
  • test:增加测试
  • chore:构建过程或辅助工具的变动
  • revert:回滚到上一个版本
  • merge:代码合并
  • sync:同步主线或分支的 Bug

scope 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。例如在 Angular,可以是 location,browser,compile,compile,rootScope, ngHref,ngClick,ngView 等。如果你的修改影响了不止一个 scope,你可以使用 * 代替。

subject 是 commit 目的的简短描述,不超过 50 个字符,结尾不需要加标点符号。

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2022-07-04,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档