좋은 git 커밋 메시지를 작성하기 위한 8가지 약속

• https://djkeh.github.io/articles/How-to-write-a-git-commit-message-kor/

커밋 메시지를 잘 쓰려고 노력해야 하는 이유

잘 쓰인 커밋 메시지가 더 유익하다. 하지만 좋은 메시지에 딱 부러진 정답은 없다.

좋은 커밋 메시지의 목표 3가지

1. 더 좋은 커밋 로그 가독성
2. 더 나은 협업과 리뷰 프로세스
3. 더 쉬운 코드 유지보수

좋은 git 커밋 메시지 작성을 위한 8가지 약속

원문에서 말하는 것은 영어로 작성하는 경우에 최적화 되어 있어
한글로 커밋 메시지를 작성한다면 좀 더 유연하게 적용하는 것도 괜찮을 듯 싶다. 라고 한다

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

   • 더 보기

     때에 따라서는 변경사항을 한 줄로 요약한 커밋 메시지가 더 효율적일 수 있다.

     하지만 충분히 내용이 있고 잘 갖춰진 커밋 메시지를 작성해야 한다면 제목과 본문 사이에 한 줄 공백을 두면 훨씬 좋은 커밋 메시지를 만들 수 있다.

     예제

       Derezz the master control program
     
       MCP turned out to be evil and had become intent on world domination.
       This commit throws Tron's disc into MCP (causing its deresolution)
       and turns it back into a chess game.

     명령어를 이용해 확인해보면 차이를 알아볼 수 있을 것이다.

       git log
       git log --oneline
       git shortlog

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

   위와 같은 맥락이다. 제목은 50자 이내로 적고 빈 라인을 한 줄 넣은 후 설명을 적자.

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

4. 제목 끝에 . 금지

   보통 제목에는 . 이 안들어 간다. 기억하자.

5. 제목은 명령조 로

   • 더 보기

     예문이 다 영어라...이해가 가지 않는다. 그냥 일단 한글로 된 예문을 그대로 가져와본다.

       인증 메소드 고쳐라
     
       * CABVerification.java: 15번째 줄 인증 메소드의 인자를 현 정책에 맞게 고쳤다.
       * JSONFormat.java: 이 커밋은 이 파일에 적절한 로깅 메소드를 추가한다.
       * MainView.java: 약간의 리팩토링.

     나중에 커밋 메시지를 작성할 때 여러 번 더 보자.

6. Github 제목(또는 본문)에 이슈 번호 붙이기

   이 부분은 나중에 다시 확인 할 것(아직 이슈를 몰라서...)

7. 본문은 영문 기준 72자 마다 줄 바꿈

   git은 자동으로 줄바꿈을 하지 않기 때문(git log에 스타일을 지정해서 자동 줄바꿈이 적용된 로그 출력을 만들수는 있음)

    git config --global alias.lg "log --graph --abbrev-commit --decorate --date=relative --format=format:'%C(bold red)%h%C(reset) : %C(bold green)(%ar)%C(reset) - %C(cyan)<%an>%C(reset)%C(bold yellow)%d%C(reset)%n%n%w(90,1,2)%C(white)%B%C(reset)%n'"

8. 본문은 어떻게 보다 무엇을, 왜 에 초점을 맞춰 작성할 것

   출처를 참고할 것