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

Habitudes personnelles :

1. Pour résoudre un problème, écrivez simplement : fixed #XX
2. Le petit changement peut être expliqué clairement en une phrase.
3. Pour les changements majeurs, créez vous-même un problème pour expliquer clairement la situation, les plans et les changements. . . . , puis pareil à 1

---

Un autre avantage ici est que #XX GitHub dans le journal de validation sera affiché sous forme de lien vers le problème correspondant, et une invite apparaîtra également dans le problème correspondant indiquant par quel commit ce problème est référencé.

Ce qui est encore plus étonnant, c'est que, comme fixed #XX, GitHub fermera automatiquement le problème pour vous.

---

En fait, le point le plus important est que le journal de validation est destiné aux humains. Expliquez simplement que vous n'avez pas besoin d'être trop formel et que vous ne pouvez pas l'écrire d'une manière réservée uniquement aux utilisateurs. machines à voir.

---

Matériel pédagogique négatif. . . On dit que deux factions complètement opposées sont représentées ici. . .

Answer 2

• Mod: remove unused code, signifie modification (Modifier) ​​
• Add: a new module to have faster process, signifie Ajouter
• Rem: deprecate unused modules, signifie supprimer
• Ref: improved the implementation of module X, signifie Refactory

Certains étudiants veulent demander : que dois-je faire si le contenu d'un commit ne peut être indiqué dans aucune des déclarations ci-dessus ?
Camarade de classe, cela signifie que votre commit doit être divisé en plusieurs petites parties

Bien sûr, mon message de commit préféré reste le premier commit, le contenu est First Blood

Answer 3

Recommandez cet article et rédigez votre message de commit