Git Commit Convention

Git Commit Message의 가이드는 왜 필요할까?

사람들과 협업을 하면서 이러한 커밋 메시지를 본다면 어떨까?

우리가 Git을 쓰는 이유는 여러 사람과 작업을 하면서 작업의 진행 상황을 공유하고 쉽게 파악하기 위해 사용한다.

Git 커밋 메시지를 보고 직관적으로 판단할 수 있어야 효율적으로 협업을 진행할 수 있다. 그래서 우리는 직관적이며 일관성 있는 약속을 바탕으로 message 작성해야 한다.

---

Udacity

Udacity는 미국의 영리 교육 기관으로 온라인 강의를 제공하는 기관이다.
Udacity는 Git Commit Message Style Guide를 제공하고 있고 많은 개발자들이 사용하고 있다.

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

---

커밋 메시지 구조

---

Type

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

---

Subject

• 제목은 50글자 내로 제한
• 제목 첫 글자는 대문자로 작성(영어)
• 제목 끝에 마침표 넣지 않기
• 영문 작성 시, 명령문을 사용하며 과거형 금지
• 국문 작성 시, 구문으로 작성

---

Body

• Subject로 표현 가능하다면 생략
• 제목으로 표현이 부족하다면 상세 내역을 작성
• 본문 72글자 제한
• what과 why를 설명

---

Footer

• 참조 정보들을 추가하는 용도(생략 가능)
• Fixes: 이슈 수정 중 (아직 해결되지 않은 경우)
• Resolves: 이슈를 해결했을 때 사용
• Ref: 참고할 이슈가 있을 때 사용

---

commit 예시

Feat: "회원 가입 기능 구현"

이메일 중복확인 API 개발

Resolves: #123
Ref: #456
Related to: #48, #45

---

Git 커밋 메시지를 체계적으로 작성하여 프로젝트 관리와 협업 측면에서 많은 도움을 받을 수 있을 것이다.

---

Gitmoji

https://gitmoji.dev

Gitmoji 란 git + emoji를 합쳐서 부르는 말로 emoji를 이용하여 commit message를 작성할 수 있다.

메시지에 이모지(이모티콘)를 더하면, 나중에 커밋 메시지를 훑어볼 때 훨씬 가독성 높게 읽기가 가능해진다.

---

Gitmoji type

Gitmoji를 사용하여 프로젝트를 진행하면서 브랜치에서 무슨 작업을 했는지 시각적으로 확인 가능했고, pr을 진행할 때 시각적으로 가독성이 높아졌다.

그렇지만 사용에 익숙하지 않아서 지속적으로 커밋을 진행할 때 사이트를 열어놓고 이모지를 찾는 것에 불편함을 느꼈다.(이 부분은 Rocket이나 gitmoji-cli를 통해서 커버가 가능하다고 생각한다.)

---

어떤것을 사용해야 할까?

무엇을 사용해도 상관없다. 팀원들과 함께 형식을 정하여 사용하면 된다.
“직관적이고 가독성 좋은 커밋 메시지" 를 작성해야 하는 것은 변하지 않는다.

---

지금까지 Commit Convention에 대해서 알아봤습니다.
다음 포스팅은 Issue와 Pull Request에 대해서 알아보겠습니다.
감사합니다. 💪🏼