의미 있는 Git 커밋 메세지를 남기는 방법

1. Introduce

커밋 메시지를 남길 때마다 “어떻게 하면 의미 있는 커밋 메시지를 남길까?”에 대해서 고민합니다.

최근 많은 분이 AngularJS Git Commit Message Conventions을 따릅니다. 그렇지만 저는 이 컨벤션을 지키면서 Type에 대해서 고민하게 되었습니다.

예를 들어서 새로운 기능을 추가할 때 feat: 기능 추가로 메시지를 남깁니다. 버그 수정 시 fix : 버그수정으로 남깁니다. 자잘한 기능 추가나 버그 수정 시 chroe: 변경 등 이렇게 남깁니다.

보기에는 명확하고 의도가 분명하지만 애매한 경우가 생길 시 type을 무엇으로 써야 할지 헷갈리는 경우도 생깁니다.

매번 수없이 고민해서 다른 방법이 없을까 하다가 다른 방식의 커밋 메시지를 남기는 방법을 찾았습니다.

제가 커밋 어떻게 남기고 관리하는지 다뤄보겠습니다.

 

2. 커밋 남기기

우선, 커밋 메시지 첫 줄에는 요약한 문장으로 적습니다. 이 부분은 실질적인 제목이 되기 때문에 요약된 내용을 한 줄로 적습니다. 마침표(.)로 끝나는 것은 바람직하지 않습니다.

[메시지 첫줄]
AccessToken과 RefreshToken 만료시간을 생성하라

[메시지 내용]
각 토큰에 만료시간을 생성 했습니다.
AccessToken은 30분 만료시간과 RefreshToken은 1일 만료시간이 적용되어 있습니다.

이렇게 커밋 메시지를 남길 때 어떤 형태를 따르기보다는 메시지 의도가 드러나게 적습니다.

우리는 제목만 보고도 내용을 유추할 수 있고 이 커밋이 무슨 일 했는지 알 수 있어야 합니다.

커밋 메시지에 맞게 해당 작업으로도 같이 있어야 합니다.

한 커밋에 관련된 내용들이 같이 있다면 무언가가 잘 못 되었을 때, 되돌리기 쉽습니다.

저는 이렇게 커밋 메시지를 남기면서 문제가 생길 때마다 그 메시지를 보고 무엇을 했는지를 파악하고 해당 커밋으로 되돌리면서 Git 관리를 합니다.

Reference

• GitHub - ikaruce/git-style-guide: A Git Style Guide 
• AngularJS Git Commit Message Conventions