Git 커밋 메시지 컨벤션

Commit Message Convention이란?

Convention이란 협약, 관례, 관습과 같은 의미를 가지고 있습니다.

 

아마 Code Convention이라는 말을 들어보신 적 있을 수도 있습니다.

여기서 사용되는 Convention이라는 의미는  "팀별로 협의해서 사용하는 스타일 규약"입니다.

 

 

Convention의 등장 배경 / 필요성

깃은 보통 협업을 위해서 많이 사용됩니다.

다른 사람과 협업하기 위해서 Commit Message를 작성할 때 팀별로 협의한 규칙을 적용한다면 다른 사람이 작성한 Commit 메시지를 보고도 한눈에 어떤 의미인지 파악할 수 있게 됩니다.

 

 

유다시티 컨벤션

유다시티는 대규모 온라인 코스를 제공하는 교육기관입니다.

가장 흔히 쓰이는 커밋 메시지 스타일인 유다시티의 스타일에 대해서 알아보겠습니다.

 

커밋 메시지의 구조

type: Subject

body

footer

 

Type(타입)

유다시티에서는 타입을 다음 7개중 하나로 쓸 것을 권장하고 있습니다.

 

타입 종류

1. feat : 새로운 기능 추가

2. fix : 오류 수정

3. docs : 문서 관련 수정

4. style : 코드가 변화지 않는 수정 ex) 세미콜론, 들여 쓰기

5. refactor : 코드의 리팩터링

6. chore : 빌드 혹은 패키지 매니저 수정사항

7. test : test 코드 삽입 및 수정

 

Subject(제목)

제목이라는 의미이며 다음과 같은 규칙이 권장됩니다.

 

- 제목은 가능한 간결하게 50자 내로 작성한다.

- 제목의 시간은 대문자로 작성한다.

- 제목은 동사 단어로 작성을 시작하고 명령문으로 작성한다.

- 제목에는 마침표를 사용하지 않는다.

 

Body(본문)

본문은 한 줄 당 72자 내로 작성한다.

본문은 최대한 상세히 작성한다.

본문에는 무엇을 왜 변경했는지를 작성한다.

 

Footer(푸터)

푸터의 작성은 생략해도 된다

푸터는 이슈 트랙킹을 위해 사용된다.

 

위의 내용을 반영한 메시지 예시

feat: 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

 

 

출처

https://haesoo9410.tistory.com/300

<Git> 커밋 메시지 컨벤션 : 유다시티

https://determination.tistory.com/entry/%EA%B9%83-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EC%BB%A8%EB%B2%A4%EC%85%98Git-Commit-Message-Convention

깃 커밋 메시지 컨벤션(Git Commit Message Convention)