Github上git commit 提交注释的规范

例如注释有这样的（转载）

一般情况下，提交 GIT 时的注释可以分成几类，可以用几个动词开始：

• Added ( 新加入的需求 )
• Fixed ( 修复 bug )
• Changed ( 完成的任务 )
• Updated ( 完成的任务，或者由于第三方模块变化而做的变化 )

尽量将注释缩减为一句话，不要包含详细的内容。
假如有 Issues 系统，其中可以包含 Issue 的 ID。比如：Issue #123456
包含作者的信息。比如 by Bruce
完整例子：
git commit -m 'Issue #[issue number] by [username]: [Short summary of the change].'
Related articles

大家的注释方式规范如何？

githubgit

关注7收藏31

回复

阅读 44.1k

 

Zhenbo_Li：

我觉得你的方法就很好了，不过我更喜欢用一般现在时

回复2014-01-28

欧雷：

「尽量将注释缩减为一句话」——你与 http://ruby-china.org/topics/15737 的作者正好相反……

回复2014-01-28

3 个回答

得票数最新

10

XiNGRZ

• 1.1k

发布于 2014-01-22

个人的习惯：

1. 修 Issue 就写：fixed #XX
2. 小改直接就用一句话说清楚。
3. 大改的，自己建一个 Issue 说清楚情况、方案、变化。。。。，然后同 1

---

这里还有一个好处是，commit log 里面的 #XX GitHub 会显示成指向对应 Issue 的链接，对应地 Issue 里面也会出现这条 Issue 被哪个 commit 引用的提示。

更屌炸天的是，类似 fixed #XX 这样的，GitHub 还会自动帮你把那条 Issue 给 close 掉。

---

其实最重要一点，commit log 是给人类看的，说清楚就好，不必太过拘谨，更不能写成只给机器看的东西。

---

反面教材。。。据说这里代表了两个完全相反的派别。。。

 

回复

 

欧雷：

本地命令行直接 git commit 之后会打开个记事本/编辑器，第一行写一句话介绍，空一行详写。

回复2014-01-28

张帆儿三疯：

 

1.修 Issue 就写：fixed #XX
2.小改直接就用一句话说清楚。
3.大改的，自己建一个 Issue 说清楚情况、方案、变化。。。。，然后同 1
@XiNGRZ 如何提交，查看的时候才能像你列出的这样显示，或者说，用git命令行提交的时候，如何换行？谢谢啦

回复2015-04-29

3

yegle

• 2.6k

发布于 2014-01-28

• Mod: remove unused code, 表示修改（Modify）
• Add: a new module to have faster process, 表示新增（Add）
• Rem: deprecate unused modules, 表示移除（Remove）
• Ref: improved the implementation of module X, 表示重构（Refactory）

有同学要问了：如果一个commit里的内容无法用上述任意一种语句陈述，应该怎么办？
同学，那说明你的commit应该被拆分成多个小部分

当然我最喜欢的commit message还是第一个commit，内容是 First Blood