Github上git commit 提交注释的规范

Question

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

一般情况下，提交 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

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

Answer 1

個人の習慣:

1. 問題を修正するには、次のように記述します: fixed #XX
fixed #XX
2. 小改直接就用一句话说清楚。
3. 大改的，自己建一个 Issue 说清楚情况、方案、变化。。。。，然后同 1

---

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

更屌炸天的是，类似 fixed #XX 小さな変化は一文でわかりやすく説明できます。

大きな変更の場合は、状況、計画、変更を明確に説明する問題を作成します。 。 。 。 、その後は 1 と同じ

---

もう 1 つの利点は、コミット ログ内の #XX GitHub が対応する問題へのリンクとして表示され、対応する問題にどの問題をコミットするかに関するプロンプトも表示されることです。によって参照されます。

---

さらに驚くべきことは、修正された #XX と同様に、GitHub がその問題を自動的にクローズしてくれることです。

実際、最も重要な点は、コミットログは人間が見るものであるということです。あまり堅苦しくする必要はなく、機械だけが見るものとして書くことはできません。 ネガティブな教材。 。 。ここには正反対の二つの派閥が代表されていると言われています。 。 。

#🎜🎜##🎜🎜##🎜🎜##🎜🎜##🎜🎜#

Answer 2

• Mod: 未使用のコードを削除、変更 (Modify) を意味します
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 追加: 処理を高速化するための新しいモジュール、新しい (追加) を意味します

レム: 未使用のモジュールを非推奨にする、削除 (削除) を意味します #🎜🎜# 参照: モジュール X の実装を改善しました、リファクトリを意味します

学生の中には、「コミットの内容が上記のステートメントのいずれにも記述できない場合はどうすればよいですか?」と尋ねる人もいます。
クラスメイト、つまり、コミットを複数の小さな部分に分割する必要があるということです#🎜🎜#

もちろん、私のお気に入りのコミット メッセージは依然として最初のコミットです。内容は First Blood#🎜🎜#

Answer 3

この記事をおすすめし、コミットメッセージを書いてください