Commit 日志规范

为了规范开发人员提交的 Commit 日志,通常会给项目设置合适的日志规范。

各社区提交规范

规范类型 提交信息格式 描述
Angular 社区提交规范 ^(feat|fix|docs|style|refactor|test|chore|ci)((.+))?: .{1,100}
jQuery 社区提交规范 ^(Fixes|Closes|Ref)? .{1,100}
Atom 社区提交规范 ^(:.*:)? .{1,72}
JSHint 社区提交规范 ^([[(FIX|FEAT|DOCS|TEST|CHORE)]])? .{1,100}
ESLint 社区提交规范 ^(Fix|Update|New|Breaking|Docs|Build|Upgrade|Chor)?: .{1,72}

日志规范要求

1、Git 提交的提交者 (Committer) 和提交作者 (Author) 必须是已验证的邮箱
2、提交的注释格式需要满足正则 ^(feat|fix|docs|style|refactor|test|chore|ci)((.+))?: .{1,100}
建议参考规范:

比如:fix(首页模块):修复弹窗 JS Bug。

type 表示 动作类型,可分为:

fix:修复 xxx Bug
feat:新增 xxx 功能
test:调试 xxx 功能
style:变更 xxx 代码格式或注释
docs:变更 xxx 文档
refactor:重构 xxx 功能或方法
scope 表示 影响范围,可分为:模块、类库、方法等。
subject 表示 简短描述,最好不要超过 60 个字,如果有相关 Bug 的 ID 号,建议在描述中加上。
作者:Jeebiz  创建时间:2022-11-03 22:14
最后编辑:Jeebiz  更新时间:2024-11-14 21:58