GIT Commit Message 요약

Posted on Edited on In Word count in article: 159 Reading time ≈ 1 mins.

git 을 사용하면서 고민스러운게 commit 시에 작성하는 메시지 문구 이다
협업에 도움이 되도록 메시지 문구 작성하는 방법과 예제를 보자

Best practices

메시지 작성시에 3단어 이상을 작성하자

너무 단순하기 입력하면 메시지만 봐서는 무슨 작업을 했는 지 알 수 없다.
심지어 본인이 작성한 메시지 인데도 말이다.

표준 영어로 작성한다

내부에서만 사용할 용도라면 한국어로 써도 되지만
영어로 사용하는 게 나중에 github 에 노출할 때 좋고 한국어 보다는 작업의 내용이 명확하다

명령형 동사로 시작한다

“Fix”, “Add”, “Change” 같은 명령어로 시작하면
git log --oneline 로 메시지를 보면 commit 의 용도가 확연하게 구분된다.

예제

잘된 예

1
2
3
4
5
6
7
8
9
“Fix a bug in the navigation”

“Add the footer to all the pages”

“Improve browser support”

“Darken the masthead colours”

“Change the title of the page”

잘못된 예

1
2
3
4
5
6
7
8
9
“asdf”

“Chagnes”

“Commit changes”

“Fixes a bug in the CSS”

“Remove the last section.”

명령형 동사 예

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
“Fix”
“Change”
“Add”
“Remove”
“Test”
“Amend”
“Calculate”
“Correct”
“Finish”
“Disable”
“Darken”
“Lighten”
“Format”
“Extract”
“Improve”
“Push”

연관포스트