[Git] 의미있는 Commit message 작성하기

💡 내가 아닌 동료를 위해 의미있는 커밋 메시지를 작성해보자!

목표

• 협업을 위해 커밋 메시지를 카테고리 별로 자세히 기록할 수 있다.
• 동료를 위해 이해하기 쉽고 명확하게 작성할 수 있다.
• 커밋 컨벤션에 따라 작성할 수 있다.

 

토이 프로젝트를 진행하든, 회사에서 업무를 진행하든 프로젝트에 대한 히스토리를 확인하게 된다.

SVN 또는 Git에 Commit 된 메시지를 확인하게 되는데, 대부분 '이게 대체 뭘 했다는거지?' 싶을 때가 많다.

 

커밋 메세지를 기록하는 것은 내가 아니라 동료를 위해 쉽고 명확하게 작성할 필요가 있다.

 

The rules — not “rules”, but better to follow:

• 제목과 본문을 개행으로 분리하기
• 제목은 간략 명확하게 작성하기 (영문 기준 50자 이내)
• 제목의 첫 글자는 대문자로 작성하기 (영문 기준)
• 제목 끝에 마침표는 찍지 말기
• 제목은 명령형으로 작성하기
• GitHub 제목(이나 본문)에 이슈 번호 붙이기
• 한 줄이 너무 길어지지 않도록 주의하기
• 본문의 경우 어떻게 보다 무엇을, 왜에 맞춰 작성하기

 

The types

feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
refactor	코드 리팩터링
test	테스트 코드, 리팩터링 테스트 코드 추가(프로덕션 코드 변경 X)
chore	빌드 업무 수정, 패키지 매니저 수정(프로덕션 코드 변경 X)
design	CSS 등 사용자 UI 디자인 변경
comment	필요한 주석 추가 및 변경
rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove	파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우

 

 

Commit Message Template

type: Subject

body

footer

For example:

Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789

 

 

 

 

출처

• "Writing git commit messages that everybody understands", Yuil Tripathee, 2019-08-24
• "How to Write a Git Commit Message", CBEAMS, 2014-08-37

 

 

 

 

Last Updated. 2023. 07. 03.