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
2. 작은 변화는 한 문장으로 명확하게 설명할 수 있습니다.
3. 큰 변화의 경우 이슈를 직접 만들어 상황, 계획, 변화를 명확하게 설명하세요. . . . , 그리고 1과 동일

---

또 다른 장점은 #XX 커밋 로그의 GitHub가 해당 이슈에 대한 링크로 표시되고 해당 이슈에 이 이슈가 참조되는 커밋에 대한 프롬프트도 표시된다는 것입니다.

더 놀라운 점은 fixed #XX처럼 GitHub가 자동으로 이슈를 닫는다는 것입니다.

---

사실 가장 중요한 점은 커밋 로그는 사람이 볼 수 있다는 점입니다. 너무 형식적일 필요도 없고, 기계만 볼 수 있는 것으로 작성할 수도 없습니다.

---

네거티브 교재. . . 여기에는 완전히 반대되는 두 파벌이 대표된다고 합니다. . .

Answer 2

• Mod: remove unused code, 수정(Modify)을 의미합니다
• Add: a new module to have faster process은 추가를 의미합니다.
• Rem: deprecate unused modules은 제거를 의미합니다.
• Ref: improved the implementation of module X은 리팩토리를 의미합니다

어떤 학생들은 다음과 같이 묻고 싶어합니다. 커밋의 내용이 위의 어떤 진술에도 명시될 수 없으면 어떻게 해야 합니까?
동창 여러분, 이는 커밋을 여러 개의 작은 부분으로 나누어야 한다는 뜻입니다

물론 제가 가장 좋아하는 커밋 메시지는 여전히 첫 번째 커밋이고 내용은 First Blood

입니다.

Answer 3

이 글을 추천하고 커밋 메시지를 작성하세요