Github의 git 커밋 주석 사양

Question

예를 들어 댓글은 이렇습니다(재게시)

일반적으로 GIT 제출 시 댓글은 여러 카테고리로 나눌 수 있으며 여러 동사로 시작될 수 있습니다.

• 추가됨(새로 추가된 요구사항)
• 수정됨(버그 수정)
• 변경됨(완료된 작업)
• 업데이트됨(작업 완료 또는 타사 모듈 변경으로 인한 변경)

댓글을 한 문장으로 줄이고 자세한 내용을 포함하지 마세요.
이슈 시스템이 있는 경우 이슈 ID가 포함될 수 있습니다. 예: 문제 #123456
작성자 정보가 포함되어 있습니다. 예: Bruce
전체 예:
git commit -m '[사용자 이름]의 문제 #[문제 번호]: [변경 사항에 대한 간단한 요약].'
관련기사

댓글을 어떻게 표준화하시나요?

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

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