좋은 git 커밋 메시지를 위한 7가지 약속

0. 커밋 첫줄 유형

• feat (feature)
• fix (bug fix)
• docs (documentation)
• style (formatting, missing semi colons, …)
• refactor
• test (when adding missing tests)
• chore (maintain)

1. 제목과 본문을 한 줄 띄워 분리하기

별거 아닐 수 있지만 git log 등을 사용했을 때 간편하게 로그를 확인 할 수 있다. 특히 git log --oneline 같은 것을 누군가 사용했을 때 위 규칙을 잘 적용했다면

 

 

깔끔하게 첫 제목만 출력되지만 만약 그렇지 않았다면 아주 많은 문장들이 출력 될 것이다.

 

2. 제목은 영문 기준 50자 이내

제목을 길게 쓰는 것은 커밋하는 사람에겐 괜찮아도 다른 사람에겐 쓸대없이 더 많은 시간을 소요해야할 수 있다.

 

3. 제목 첫 글자는 대문자로

영어에선 그래야함!

 

4. 제목 끝에 . 금지

영문법에서 그렇다고 함

5. 제목은 명령조로

영문법에서 그렇다고 함

6. 본문은 영문 기준 72자마다 줄 바꾸기

읽기 쉽도록 그렇게 한다고 한다.

7. 본문은 "어떻게" 보다 "무엇을", "왜"에 맞춰 작성하기

이분탐색을 사용해 탐색 속도를 향상시킴 [X]

기존 탐색 로직을 탐색 속도 이슈를 해결하기 위해 이분탐색으로 변경 [O]