Git - Commit 컨벤션

작성일 | In

커밋 메시지를 작성할 때는 원칙을 정하고 일관성 있게 작성해야한다.
아래 내용은 Udacity Git Commit Message Style Guide에 따라 작성된 내용입니다.

git 커밋 메시지를 잘 쓰려고 노력해야 하는 이유

  • 더 좋은 커밋 로그 가독성
  • 더 나은 협업과 리뷰 프로세스
  • 더 쉬운 코드 유지보수



Commit Message Structure

기본적으로 커밋 메시지는 아래와 같이 제목/본문/꼬리말로 구성한다.

1
2
3
4
5
type : subject

body

footer



Commit Type(유형)

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  • refactor : 코드 리팩토링
  • test : 테스트 코드, 리팩토링 테스트 코드 추가
  • chore : 빌드 업무 수정, 패키지 매니저 수정



Subject(제목)

  • 제목은 50자를 넘기지 않고, 첫문자는 대문자로 작성하고 마침표를 붙이지 않는다.
  • 제목 줄은 유형 : 제목의 형식으로 작성한다.
  • 명령어로 작성한다.
    • “Fixed” -> “Fix”
    • “Added” -> “Add”



Body(본문)

  • 선택사항이기 때문에 모든 커밋에 본문 내용을 작성할 필요는 없다.
    • 예) 세미콜론 누락 같은 경우, 본문 없이 한줄로 작성하는 것이 깔끔하다.
  • 부연설명이 필요하거나 커밋의 이유를 설명할 경우 작성해준다.
  • 한 줄에 72자를 넘기지 않고 제목과 구분되기 위해 한칸을 띄워 작성한다.
  • 본문 내용은 어떻게 변경했는지보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.



Footer(꼬리말)

  • 선택사항이기 때문에 모든 커밋에 꼬리말을 작성할 필요는 없다.
  • issue tracker id를 작성할 때 사용한다.”유형 : #이슈번호”형식으로 작성한다.
  • 이슈 트래커 유형은 다음 중 하나를 사용한다.
    • 해결 : 이슈 해결 시 사용
    • 관련 : 해당 커밋에 관련된 이슈번호(아직 해결되지 않은 경우)
    • 참고 : 참고할 이슈가 있을 때 사용



For example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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



참고