【GIT】git-commit Angular规范--- 编辑中

本文介绍了Angular规范下的git-commit格式,包括head、body和footer三部分,强调了commit message的重要性和在代码管理中的作用。同时,分享了一个博主采用的commit规范,以及详细的提交模板,帮助开发者遵循最佳实践。
摘要由CSDN通过智能技术生成

目录

1、背景

2、Angular规范

3、实例

4、某个博主采用的commit规范

5、提交模板


1、背景

目标

按照一定的规范写 commit messages,可以git push 代码之前(工具/脚本自动)检测commit messages。规范提交信息。

规范提交信息的目的:

  • 生成 CHANGELOG.md
  • 识别不重要的提交
  • 在浏览 Git 历史时提供更多信息

git push 代码之前检测commit messages的工具(部署在git服务器上,用户每次提交commit messages都会被检测)

  1. commitlint
  2. husky

2、Angular规范

按照Angular规范,commit message 分3个部分:head, body, footer

head: <type> (scop): subject

type: feat, fix, docs, style, refactor, test, chore, revert, perf, build
score: 影响范围
subject: 简短描述(动词开头,首字母小写,结尾不加.)


body: 详细描述
footer: (1) 不兼容改动;(2) 关闭issue

3、实例

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

feat的修改

feat(影响论坛的相关模块):增加点赞功能

(这里是空行)

论坛跟帖增加点赞功能,增加用户体验……

(这里是空行)

解决了名字ID冲突bug





fix的提交

fix(影响论坛的相关模块):修改点赞的bug

(这里是空行)

修改点赞大拇指颜色不变红的bug……

(这里是空行)

close #2143


test的提交

test:增加测试并发登录

(这里是空行)

增加测试并发登录的代码,并发用户量可以设置


docs的提交

docs:增加工程说明文档

(这里是空行)

怎加工程说明文档 《xxxxx工程说明.doc》


……







revert 有特殊的格式

# head: revert: <要被撤销的commit的head>
# body: This reverts commit <commit-hash>.
# eg:
	revert: docs add README.md
	This reverts commit a2d04c0b914785e4ff0cdf4baeea84d
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: git-commit-lint-vscode是一个用于在VSCode编辑进行Git提交消息规范检查的工具。在软件开发过程,良好的提交消息规范可以提高团队协作效率,方便代码版本追踪和维护。 该工具的主要功能是对Git提交消息进行自动检查,以确保它们符合预定义的规范。它会根据事先定义好的规则,对提交消息进行语法、格式和内容等方面的检查,并给出相应的错误或警告提示。这有助于保持项目提交消息的一致性和准确性。 git-commit-lint-vscode可以在VSCode的编辑直接集成,使开发者可以在提交代码时即时检查提交消息,避免出现格式错误、无意义或不清晰的消息。这样做不但可以提高团队协作效率,还可以减少代码维护由于提交消息造成的困惑和不必要的麻烦。 使用这个工具,可以定义自己项目所需的提交消息规范,如消息长度、格式、命名约定等等。开发者只需要按照规范进行提交消息的编写,工具就会自动进行检查和提示。这样做可以使开发者更加专注于代码本身,而不必担心提交消息的错误或不规范。 总而言之,git-commit-lint-vscode是一个方便的工具,可以帮助开发者在VSCode编辑进行Git提交消息规范的检查。通过提供实时的错误和警告提示,它有助于保持项目提交消息的一致性和准确性,提高团队协作效率,减少代码维护的问题。 ### 回答2: git-commit-lint-vscode是一个用于在VSCode进行Git提交信息规范检查的插件。 Git提交信息是开发过程非常重要的一部分,它不仅包含了开发者的改动内容,还包含了一些必要的描述和其他信息。一个良好的Git提交信息规范能够提高代码的可读性,方便团队协作和代码维护。 git-commit-lint-vscode插件是为了帮助开发者在VSCode更好地遵守Git提交信息规范而设计的。它会通过检查你的提交信息,并根据预定义的规则给予提示和建议。 这个插件可以配置一些常见的规则,比如提交信息的格式、长度、语法等。当你在提交代码时,它会在VSCode的编辑给出相应的错误或警告提示,帮助你及时发现并修复不规范的提交信息。 除了简单的格式和语法检查,git-commit-lint-vscode还支持自定义规则的配置。你可以根据团队的开发规范,添加一些额外的规则来检查特定的提交信息要求。 使用git-commit-lint-vscode插件可以帮助团队统一和规范Git提交信息的格式,避免不规范的提交信息对代码维护和合作造成不必要的困扰。同时,它也能帮助开发者养成良好的提交信息习惯,提高自己的编码质量。 综上所述,git-commit-lint-vscode是一个实用的插件,它通过在VSCode检查和提醒开发者规范Git提交信息,提升团队的协作效率和代码质量。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值