[TIPS] Git | 간결한, 깔끔한 Commit message 작성을 위한 기본 팁

저는 별도의 파일에 작성하는 게 번거롭습니다. 혹시나 해당 내용을 찾으시는 분이라면, 이 링크, 혹은 이 링크를 통해 다른 분의 블로그를 확인해주세요!

 

Commit Message

커밋 메시지는 현재까지의 작업진행 상황을 저장해두거나, 새로운 기능을 만들어 Git에 추가해줄 때에 사용한다. 매번 정성들여 커밋메시지를 작성하기에는 지금 작업이 별 거 없다고 느껴질 지 모르지만, 나중에 시간이 지나고 돌아보면 무슨 내용인지 모를 때가 많다. 반면에 깔끔하고 규칙적인 커밋메시지는, 내용을 모르는 사람마저 편안하게 만들어준다.

 

물론 커밋 메시지를 작성하는 것에 정해진 규칙은 없다. 단지 자신만의 규칙이 있을 뿐....

예시

 

위 예시의 커밋메시지는 좀 들죽 날쭉하다. solo, pair, badaro, const 등 무엇을 뜻하는 지 파악하기가 힘들다.

만약 이게 공부를 위한 프로젝트가 아니었고, 치명적인 버그를 발견해 이전의 버전으로 돌릴 필요가 있다고 가정해보자.

어디로 돌아가고 싶은가? 적어도 혼돈의 카오스로는 돌아가면 안될 것 같다.

 

자신만의 규칙을 만들자

고 이야기 해도, 이미 그들의 리그에는 몇 가지 기본 규칙이 있다! 이 기본규칙이 허용하는 범위 아래에서, 자신만의 규칙을 세워보자

1. 첫 글자는 대문자 ( add something : x | Add something : o )
2. 현재형 동사로 시작 ( Part 1 completed : x | Complete part 1 : o )
3. 마침표 찍지 않기 ( Complete part 1. : x | Complete part 1 : o )
4. 기분이나 감정표현 넣지 않기 ( solo, step4, prepend 적용, for문은 혼돈의 카오스 : x | Apply prepend for step 4 without someone : o )

이제 여기서부터는 발전을 시켜나가면 된다.

나의 경우에는 "현재 진행상황: 무엇을 했다 ( 필요하다면, 어디에 있는 무슨 파일의 무엇을 위해 )" 라고 작성한다.

 

다른 예시

나도 커밋을 계속 해보면서 나만의 규칙을 만들어가고 있다!

다듬고, 다듬고, 또 다듬어 언젠가는 내 마음에 쏙드는 깔끔한 메시지를 작성해보자!