그 동안 깃허브에 잔디를 심으면서 커밋 메세지에 아무 말이나 적어서 커밋을 하곤 했다. 보는사람이 나밖에 없으니까 딱히 불편함을 느끼지 못하고 작성을 했었는데, 최근 협업을 하면서 커밋 메세지의 중요성에 대해서 알게되었다. 커밋 메세지를 잘 작성한다면 팀원들간의 협업이 편해지고, 코드리뷰나 유지보수가 편리해질것이다! 좋은 커밋 메세지를 작성하기위해 커밋 메세지의 구조와 커밋 메세지를 작성하기 위한 7가지 약속에 대해 알아보자 q(≧▽≦q)

📢 커밋 메세지의 구조

<type>[scope(선택 사항)] : <description>

[body(선택 사항)]

[footer(선택 사항)]

subject line (제목)

변경사항에 대한 간단한 설명을 type, scope, description을 이용해 표현한다.

type

커밋에 기록된 작업들이 무엇인지 알려주는 역할로 종류는 다음과 같다.

• feat : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 서식 지정, 세미콜론 누락 등 코드 변경이 없는 경우에
• refactor : 코드 리팩터링
• test : 누락된 테스트 코드를 추가할 때
• chore : 빌드 업무나 패키지 매니저 수정할 때

scope

해당 커밋이 어떤 것, 어떤 범위의 수정 사항인지 부가적인 설명을 작성하는 부분으로 협업때 범위에 대한 정보를 포함해서 커밋 메세지를 작성하게 된다면 서로의 업무를 파악하는데 도움이 된다.

ex) $ location, $ browser, $ compile, $ rootScope, ngHref, ngClick, ngView 

description

해당 커밋의 작업 내용을 요약해서 적어야 한다. Add product detail information get method와 같이 현재형 동사로 적는 것이 일반적이다.

body (본문)

본문에는 수정을 하게된 이유와 이전 변경 사항을 작성한다. 명령형과 현제 시제, 동사 원형을 사용하여 표현한다.

footer (바닥글)

푸터에는 무엇을 왜 고쳤는지, migration은 어떻게 해야하는지 작성한다. 해결한 이슈가 있다면 Closes 키워드로 시작해 작성한다

Closes #123, #234, #999

⭐ 좋은 커밋 메세지를 작성하기 위한 7가지 약속

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

git lot —oneline 옵션을 사용 시 제목만 간단하게 볼 수 있다.

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

50자 이내로 작성하게 되면 가장 간결하게 요약된 제목을 작성할 수 있다.

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

영문법에서는 첫 글자를 대문자로 작성하는것이 아주! 중요하다

4. 제목 끝에 . 금지

영문법에서는 제목에 보통 . 을 찍지 않는다.

5. 제목은 명령조로!

커밋 메세지의 가장 첫 문장의 영문법은 명령조로 즉, 동사 첫 단어를 동사 원형으로 써야한다. git 스스로가 자동 커밋을 작성할때 명령문을 사용하고 있기 때문이다.

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

git log 명령어 입력시 보기 좋은 메세지를 만들고 싶다면 72자 간격으로 엔터키를 눌러 줄바꿈을 해주면 된다.

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

본문의 내용은 왜 에 맞춰서 작성해야 한다.

📚 Ref

https://meetup.toast.com/posts/106
https://www.conventionalcommits.org/ko/v1.0.0/
https://velog.io/@new_wisdom/Clean-Coding-Commit-Message-Conventions