Commit Message Convention

1. 정의

커밋 메세지를 작성할 때는 원칙을 정하고 일관성 있게 작성해야 한다. 해당 문서는 유다시티의 커밋 메세지 스타일 가이드를 참조했다.

2. Commit Type

• 제목은 50자 이내, 대문자를 사용하고 마침표를 붙이지 않는다.
• 과거 시제를 사용하지 않고, 명령어를 사용한다.
  • “Fixed” → “Fix”
  • “Added” → “Add”

3. 논쟁의 요소

3-1. 커밋 메세지 영어로? 한글로?

⇒ 여론은 영어가 주축이긴 하나, 공개된 프로젝트가 아닌 관계자들만 볼 환경이라면 한글이든 영어든 그 분위기에 맞게 쓰는 여론이다. (오픈소스일 경우, 영어로 하자는 여론이 더 강하다)

3-2. Commit Type 앞을 어떻게 꾸밀것인가?

// Commit Message
[Fix] 로그인 버그 해결
Fix: 로그인 버그 해결

⇒ 어떤 형태를 사용할 것 인지는 자유다. (개인적으론 대괄호가 더 깔끔한듯?)

4. 한 개의 커밋에 여러가지 내용을 담아도 되는가?

안된다. 1개의 커밋에는 1개의 내용만 들어가야 한다.

예를 들어, [Feat] 로그인 기능 구현 이라는 커밋 메세지를 날렸다면 로그인 기능 구현에 해당하는 변경사항만 들어가야 한다. 다른 내용이 섞일경우 추적이 쉽지 않다.

5. 실사용 예