[깃허브] 커밋 메세지 스타일2

좋은 커밋 메세지 스타일
1. 규칙 및 구조
2. 자주 사용하는 단어
3. 템플릿 설정하기

1. 규칙

제목

본문

푸터

• 각 사항은 공백의 라인으로 구분한다.
• 제목 줄은 가급적 50자로 제한하고, 가능한 간결하게 작성한다.
• 제목의 시작은 대문자로 작성한다.
• 제목에 마침표를 사용하지 않는다.
• 제목은 동사로 시작하여 명령형으로 작성한다. 이렇게 작성함으로써 Git 자체가 사용하는 메시지와 통일될 수 있다. 예를 들어 merge를 했다고 가정하자. 그러면 자동으로 아래와 같은 메시지가 로그에 작성된다.

Merge branch 'test'

• 본문은 72자 단위로 줄바꿈을 시행한다.
• 본문을 통해 무엇을, 왜 등을 설명한다. 생략해도 좋지만 코드 변경의 이유를 명확히 작성할수록 코드를 읽는 이가 감사해할 것이다.

2. 자주 사용하는 단어

1) Fix

Fix my test
Fix typo in style.css
Fix my test to return undefined
Fix error when using my function

• 잘못된 동작을 고칠 때 주로 사용한다.
• 단순히 명사만 작성하여 수정했음을 나타낼 수 있다.
• in 을 명시하여 어디를 수정했는지 작성할 수 있다.
• to 또는 for 로 왜 그렇게 수정했는지 작성할 수 있다.
• when을 통해 어느 상황에서 발생했는지를 작성할 수 있다.

2) Add

Add style.css
Add mytest.test for test
Add blue color to style.css

• Fix와 함께 가장 많이 쓰이는 단어이다. 무언가 추가할 때 사용한다.
• 단순히 코드나 문서가 추가되었음을 작성할 수 있다.
• 왜 추가했는지 무엇을 어디에 추가했는지 등을 나타낼 수 있다.

3) Remove

Remove test.js
Remove black color from style.css

• 삭제가 있을 때 사용한다.
• from을 적어서 어디에서 삭제했는지 명시할 수 있다.

4) Simplify

• 코드를 단순화 했을 때 사용한다.

5) Update

Update harry-server.js to use HTTPS

• Fix와 달리 원래 정상적으로 동작했지만 보완하는 개념이다.

6) Implement

• 무언가 구현을 달성했을 때 사용한다.
• 큰 단위에 작성하면 좋다.

7) Prevent

Prevent hello handler from saying Hi in hi.js

• 특정한 동작을 못하게 막을 때 사용한다.

8) Move

• 코드나 파일의 이동에 사용한다.
• Move A to B, Move A into B의 형태로 많이 쓰인다.

9) Rename

• 이름의 변경이 있을 때, Rename A to B의 형태로 많이 쓰인다.

3. 템플릿 설정하기

git commit -m "제목

본문

푸터"

• 먼저 .gitmessage.txt 파일을 생성하고, 자신이 원하는 형식으로 작성한다.

# Harry's commit message template
# 제목은 대문자로 시작합니다.
# 본문과 푸터는 선택 사항 입니다.
#######제목#######

#######본문#######

#######푸터#######

##################
# Fix : 수정
# Add : 추가
# Remove : 삭제
# Simplify : 단순화
# Update : 보완
# Implement : 구현
# Prevent : 방지
# Move : 이동
# Rename : 이름변경
##################

• '#'은 모두 주석이다. push하면 올라가지 않는다.
• 비어 있는 첫 번째 줄에 글을 작성하면 그것이 커밋 메시지 중 제목으로 작성된다.
• 비어 있는 마지막 줄은 푸터가 된다.
• 파일을 작성했으면 저장하고 아래의 명령어를 입력한다.

git config --global commit.template <.gitmessage.txt 경로>

• <...> 부분은 통째로 경로를 작성해야한다.
• 이제 git commit 을 입력하면 아래와 같이 템플릿이 자동으로 뜨게 된다.
• vi 에디터 명령어로 작성한다.
• 먼저 i를 입력하여 수정모드로 진입하여 필요한 부분을 작성한다.
• 다 작성했으면 esc 를 누르고, :wq 를 입력해 저장하면 commit이 완료된다.

참고
https://haesoo9410.tistory.com/299?category=909362