Java开发-实际工作经验和技巧-0003-容易被忽视的Git提交代码规范

最新推荐文章于 2024-07-14 14:59:27 发布

CodeZeng1998

最新推荐文章于 2024-07-14 14:59:27 发布

阅读量914

点赞数 29

分类专栏： Java开发-实际工作经验和技巧文章标签： java git 代码规范 intellij-idea

本文链接：https://blog.csdn.net/weixin_43873121/article/details/139991732

版权

6 篇文章 0 订阅

订阅专栏

更多内容欢迎关注我（持续更新中，欢迎Star✨）

Github：CodeZeng1998/Java-Developer-Work-Note

技术公众号：CodeZeng1998（纯纯技术文）

生活公众号：好锅（Life is more than code）

CSDN: CodeZeng1998

其他平台：CodeZeng1998、好锅

本文分享一个容易被大家忽视的 Git 里面的规范相关的内容，那就是提交信息的编写规范。

好的 Git 的提交信息，要满足几个条件：

下面介绍详细的内容，大家可以按照这个规范来进行 Git 提交信息的编写（推荐），或者按照公司自定义规范进行相应的提交信息的编写。

提交信息的格式如下：

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

<body>

BREAKING CHANGE: <changes>

Closes <closes>

<skipCi>

In file templates, you can use text, code, comments, and predefined variables. The following provides a list of predefined variables.

Predefined variables take the following values:

标识	含义
${type}	Corresponds to the submission menu ‘Type of change’
${scope}	Corresponds to the submission menu ‘Scope of this change’
${subject}	Corresponds to the submission menu ‘Short description’
${body}	Corresponds to the submission menu ‘Long description’
${changes}	Corresponds to the submission menu ‘Breaking changes’
${closes}	Corresponds to the submission menu ‘Closed issues’
${skipCi}	Corresponds to the submission menu ‘Skip CI’
${newLine}	’ ', indicating whether to wrap the line

最常用的其实是如下模板：即 类型(范围): 简短信息

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

下面介绍一下 type 的详细使用：

类型种类	含义
feat	A new feature
fix	A bug fix
docs	Documentation only changes
style	Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor	A code change that neither fixes a bug nor adds a feature
perf	A code change that improves performance
test	Adding missing tests or correcting existing tests
build	Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci	Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore	Other changes that don’t modify src or test files
revert	Reverts a previous commit