git：git commit 书写格式

最新推荐文章于 2024-02-26 15:47:39 发布

JNingWei

最新推荐文章于 2024-02-26 15:47:39 发布

阅读量2k

点赞数 3

分类专栏： Git 使用文章标签： git

本文链接：https://blog.csdn.net/jningwei/article/details/74294464

版权

Git 使用专栏收录该内容

17 篇文章 13 订阅

订阅专栏

git commit 的来源 & 如何使用

正如 git add 的作用是将文件放入暂存区， git commit 的作用是将修改提交到分支上。

如果只写一句话，那么以下指令即可：

git commit -m 'Hello Commit !'

如果想写一整段话，那么输入以下指令，可跳转到文本编辑器界面大书特书：

git commit

目前，社区有多种 Commit message 的写法规范。经过查阅和比较，我自己采用的是 Angular 规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

Angular 规范

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

标题行：50个字符以内，描述主要变更内容

主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括: 
    - 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
    - 他如何解决这个问题? 具体描述解决问题的步骤
    - 是否存在副作用、风险? 

尾部：如果需要的化可以添加一个链接到issue地址或者其它文档，或者关闭某个issue。

参数说明

一行，三个字段。type（必需）、scope（可选）和subject（必需）。

type： 代表某次提交的类型，比如是修复一个bug还是增加一个新的feature。

type类型	Annotation
feat	新功能（feature）
fix	修补bug
docs	仅仅修改了文档，比如README, CHANGELOG, CONTRIBUTE等等
style	仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
refactor	代码重构，没有加新功能或者修复bug
test	测试用例，包括单元测试、集成测试等
chore	改变构建流程、或者增加依赖库、工具等
revert	回滚到上一个版本

scope： 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
subject： 是 commit 目的的简短描述，不超过50个字符。

Body部分

是对本次 commit 的详细描述，可以分成多行。

范例：

More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

使用第一人称现在时，比如使用change而不是changed或changes。
应该说明代码变动的动机，以及与以前行为的对比。

Ref：

JNingWei

关注

3
点赞
踩
0

收藏

觉得还不错? 一键收藏
1
评论
git：git commit 书写格式

git commit 的来源 & 如何使用正如 git add 的作用是将文件放入暂存区， git commit 的作用是将修改提交到分支上。如果只写一句话，那么以下指令即可：git commit -m 'Hello Commit !' 如果想写一整段话，那么输入以下指令，可跳转到文本编辑器界面大书特书：git commit 目前，社区有多种 Com
复制链接

扫一扫