git commit message convention

최근 git commit message convention에 대한 글을 보게 되었다.

재미있는 방법인거 같아 내용정리 겸 글을 써보고자 한다.

 

사실 나는 밑의 그림처럼 [jira 이슈넘버][깃모지][주제] 정도로 적어왔다.

나의 깃 커밋 메세지 예시

근데.. 이렇게 작성하게 되면 커밋메세지가 많아질수록 헷갈려져서 솔직히 jira를 보지 않으면 나중엔 잘 기억이 나지않는다..

---

서론은 여기까지 하고 내가 찾은 이 git commit message style은

Udacity Git Commit Message Style Guide 에서 읽은 내용이다.

 

메세지의 구조는 다음과 같다.

type: Subject

body

footer

type : 말 그대로 message type이고 type의 종류는 밑의 그림과 같다.

https://udacity.github.io/git-styleguide/

subject : 이 커밋이 하는 일을 설명. 50글자를 넘기지 않는게 원칙.

 

body : body는 그 스타일 가이드에 밑의 글처럼 적혀있다. 72글자를 넘기지 않는게 원칙.
Use the body to explain the what and why of a commit, not the how. 

 

footer (optional) : issue traker id를 입력하란다. ex) jira ticket number 등등.. 

---

사이트에서 주어진 예시는 다음과 같다.

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

---

좋은 방법이긴 한데.. 많은 인력이 같이 협업하는 경우가 아니라면
좀 오바인거 같다. 

자신의 사정에 맞춰 사용하면 베스트일거 같다.

 

git commit의 convention을 맞추도록 강제하는 환경 세팅하는 튜토리얼을 작성해보았다! 참고하면 좋을것 같다!
https://kunkunwoo.tistory.com/286

git commit convention 잘지키는 환경 구성하기! (with commitlint, release-it) - 1. 환경구성하기

---

참고

https://udacity.github.io/git-styleguide/

Udacity Nanodegree Style Guide