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

Tabiat peribadi:

1. Untuk membetulkan Isu, tulis sahaja: fixed #XX
2. Perubahan kecil itu boleh dijelaskan dengan jelas dalam satu ayat.
3. Untuk perubahan besar, buat sendiri Isu untuk menerangkan situasi, rancangan dan perubahan dengan jelas. . . . , dan kemudian sama dengan 1

---

Faedah lain di sini ialah #XX GitHub dalam log komit akan dipaparkan sebagai pautan ke Isu yang sepadan dan gesaan juga akan muncul dalam Isu yang sepadan tentang yang melakukan Isu ini dirujuk oleh.

Apa yang lebih menakjubkan ialah, seperti fixed #XX, GitHub akan menutup isu untuk anda secara automatik.

---

Malah, perkara yang paling penting ialah log komit adalah untuk dilihat oleh manusia. Anda tidak perlu terlalu formal, dan anda tidak boleh menulisnya dengan cara yang hanya untuk mesin untuk dilihat.

---

Bahan pengajaran negatif. . . Dikatakan dua puak yang bertentangan sama sekali diwakili di sini. . .

Answer 2

• Mod: remove unused code, bermaksud pengubahsuaian (Ubah suai)
• Add: a new module to have faster process, bermaksud Tambah
• Rem: deprecate unused modules, bermaksud membuang
• Ref: improved the implementation of module X, bermaksud Refactory

Sesetengah pelajar ingin bertanya: Apakah yang perlu saya lakukan jika kandungan dalam komit tidak boleh dinyatakan dalam mana-mana pernyataan di atas?
Rakan sekelas, ini bermakna komitmen anda harus dibahagikan kepada beberapa bahagian kecil

Sudah tentu mesej komit kegemaran saya masih komit pertama, kandungannya First Blood

Answer 3

Syorkan artikel ini dan tulis Mesej Komit anda