여러 사람들이 작업하는 프로젝트에 대해서 수정한 사항에 대한 커밋 메시지를 남겨야합니다.
이 커밋 메시지를 작성할 때 원칙을 정하고 일관성 있게 작성해야 합니다.
[AngularJS Commit convetions] 를 참고하여 Commit Message Convention에 대해서 공부해 보려고 합니다.
Commit Message Structure
기본적으로 커밋 메시지는 아래와 같이 제목/본문/꼬리말로 구성됩니다.
type : subject
body
footer
- 공백의 라인이 들어가는 것에 주의해야합니다
Commit Type
- feat : 새로운 기능 추가
- fix : 버그 수정
- docs : 문서 수정
- style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
- refactor : 코드 리팩토링
- test : 테스트 코드, 리팩토링 테스트 코드 추가
- chore : 빌드 업무 수정, 패키지 매니저 수정
Subject
- 제목은 50자를 넘기지 않고, 대문자로 작성하며 마침표를 붙이지 않습니다.
- 과거 시제를 사용하지 않고 명령어로 작성합니다.
- "Chages" 👉 "Change"
Body
- 선택사항이기에 모든 커밋에 본문 내용을 작성할 필요는 없습니다.
- 부연 설명이 필요하거나, 커밋의 이유를 설명해야할 경우 작성합니다.
- 72자를 넘기지 않고 제목과 구분되기 위해 한 칸을 띄워 작성합니다.
Footer
- 선택사항이기 때문에 모든 커밋에 꼬리말을 작성할 필요는 없습니다.
- issue tracker id를 작성할 때 사용합니다.
- 예시 :
Closes #123, #245, #992
Example
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 consequenses 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참고
