git commit 格式规范

本文详细介绍了Angular项目的commit规范,包括类型、范围和主题的使用,适用于团队协作中代码提交的标准流程,有助于保持代码仓库的清晰和高效。

Angular规范
commit message格式

<type>(<scope>): <subject>

type(必须)
用于说明git commit的类别,只允许使用下面的标识。

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

subject(必须)
subject是commit目的的简短描述,不超过50个字符。
建议使用中文(感觉中国人用中文描述问题能更清楚一些)。
结尾不加句号或其他标点符号。

Git commit信息规范有助于团队协作和项目管理,常见的规范有以下几种: ### Conventional Commits规范 这种规范定义了一种人类和机器都容易理解的提交信息格式格式如下: ``` <类型>[可选 范围]: <描述> [可选 正文] [可选 脚注] ``` - **类型(type)**:用于说明本次提交的类型,常见的类型有: - `feat`:新功能(feature) - `fix`:修补bug - `docs`:文档(documentation) - `style`:格式(不影响代码运行的变动) - `refactor`:重构(即不是新增功能,也不是修改bug的代码变动) - `test`:增加测试 - `chore`:构建过程或辅助工具的变动 - **范围(scope)**:可选参数,用于说明本次提交影响的范围。 - **描述(description)**:对本次提交的简短描述,不超过50个字符,用动词原形开头,首字母小写,结尾不要加句号。 - **正文(body)**:可选,对本次提交的详细描述,可以分成多行。 - **脚注(footer)**:可选,用于记录不兼容变更、关闭的issue等信息。 示例: ``` feat(user): add user registration feature This commit adds a new user registration feature to the application. It includes a registration form and validation logic. Closes #123 ``` ### Angular规范 与Conventional Commits规范类似,也是将提交信息分为类型、范围、描述等部分。类型主要有: - `build`:影响构建系统或外部依赖的更改 - `ci`:对CI配置文件和脚本的更改 - `docs`:文档更改 - `feat`:新功能 - `fix`:修复bug - `perf`:提高性能的更改 - `refactor`:既不修复错误也不添加功能的代码更改 - `style`:不影响代码含义的更改(空格、格式、缺少分号等) - `test`:添加缺失的测试或更正现有测试 示例: ``` fix(login): correct password validation regex The previous regex for password validation was incorrect. This commit updates it to the correct regex. Resolves #456 ``` ### 自定义规范 团队也可以根据自身需求制定自定义的提交信息规范。例如,要求提交信息包含任务编号、简要描述等。 示例: ``` [Task-789] Update user profile page layout ``` 在实际使用中,为了确保团队成员都能遵循规范,可以使用工具进行校验,如`commitlint`。
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值