이번에 프로젝트를 시작하게 되는데 혼자 진행하는 프로젝트가 아니기 때문에 커밋 내용을 보고 팀원이 해당 내용을 파악하는데 시간을 쏟지 않았으면 좋겠다라는 생각이 들어, 프로젝트를 진행하기 앞서 깃 커밋 컨벤션을 정리합니다.

Commit 메시지 구조

• 기본적으로 커밋 메시지 구조는 제목, 본문, 꼬리말 파트로 나누어지고, 각 파트는 빈줄을 두어서 구분합니다.

type : subject(#이슈번호)

body

footer

제목 작성

Commit Type

태그는 영어로 작성하고 첫 문자는 대문자로 시작해야합니다.

• Feat : 새로운 기능을 추가
• Fix : 버그 수정
• Docs : 문서 수정
• Style : 코드 포멧팅, 세미콜론 누락, 코드 수정이 없는 경우
• Refactor : 코드 리팩토링
• Test : 테스트 추가
• Chore : 빌드 작업, 패키지 매니저 수정

Subject

• 제목은 최대 50자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않습니다.
• 제목은 개조식 구문으로 작성합니다. (짧게 끊어서 중요한 요점이나 단어를 나열하는 방식)
• 제목 끝에는 (#이슈번호)를 추가합니다. (제목의 이슈번호를 보고 어떤 이슈와 관련있는지 한눈에 확인하기 위함)

제목 작성 예시
Feat: 로그인 구현(#123)

본문 작성

• 본문 작성은 선택사항입니다.
• 본문을 작성할 때는 제목과 본문 사이에 빈 줄이 있어야 하며, 각 줄의 길이는 72자 내로 작성해야합니다.
• 본문 내용은 내용과 이유를 작성해야 합니다. 어떻게를 설명해서는 안됩니다.

꼬리말 작성

• 꼬리말은 선택 사항이고 이슈 트래커 ID를 작성합니다.
• 꼬리말 형식은 유형: #이슈 번호입니다.
• 여러 개의 이슈 번호를 적을 때는 쉼표로 구분합니다.
• 이슈 트래커 유형은 다음 중 하나를 사용합니다.
  • Fixes : 버그 수정이나 문제가 해결될 때 사용합니다. (해결)
  • Resolves : 버그 수정 뿐만 아니라 기능 구현, 작업 완료가 될 때 사용합니다. (해결)
  • Related to : 해당 커밋에 관련된 이슈번호 (해결 x)

커밋 메시지 작성 예시

Feat: 사용자 로그인 기능구현(#123)

사용자가 이메일과 비밀번호를 통해 로그인할 수 있는 기능을 추가했습니다.
로그인 성공 시 JWT 토큰을 발급받으며 로컬 스토리지에 저장합니다.

Resolves : #123

참고글

https://udacity.github.io/git-styleguide/
https://overcome-the-limits.tistory.com/entry/%ED%98%91%EC%97%85-%ED%98%91%EC%97%85%EC%9D%84-%EC%9C%84%ED%95%9C-%EA%B8%B0%EB%B3%B8%EC%A0%81%EC%9D%B8-git-%EC%BB%A4%EB%B0%8B%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0