Git 커밋 메시지 컨벤션

커밋 메시지 구조

1. 제목

태그설명

Feat	새로운 기능을 추가한 경우
Fix	에러를 수정한 경우
Design	CSS 등 UI 디자인을 변경한 경우
BREAKING CHANGE	중대한 API를 변경한 경우
HOTFIX	급하게 치명적인 에러를 고친 경우
Style	코드 포맷 변경을 하거나 세미 콜론 누락하여 추가하면서 코드 수정이 없는 경우
Refactor	코드를 리팩토링한 경우
Comment	주석을 추가하거나 변경한 경우
Docs	문서를 수정한 경우
Test	테스트 코드를 추가, 변경, 리팩토링한 경우
Chore	기타 변경사항 (빌드 스크립트 수정, 패키지 매니징 설정 등)
Rename	파일 or 폴더명 수정하거나 옮기는 경우
Remove	파일을 삭제하는 작업만 수행한 경우

• << 태그 >> : << 요약 메시지 >> 형식으로 작성합니다.
• 제목의 처음은 동사 원형으로 시작합니다.
• 총 글자 수는 50자 이내로 합니다.
• 문장의 끝에 특수문자는 삽입하지 않습니다. 예) ., !, ?

2. 본문

• 본문은 한 줄 당 72자 이내로 합니다.
• 본문 내용은 양에 구애받지 않고 최대한 상세히 작성합니다.
• 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명합니다.

3. 꼬릿말은 아래에 작성: ex) #이슈 번호

• 꼬리말은 반드시 작성할 필요는 없습니다.
• << 유형 >>: #<< 이슈 번호 >> 형식으로 작성합니다.
• 여러 개의 이슈 번호를 적을 때는 쉼표로 구분합니다.
• 이슈 트래커 유형은 다음 중 하나를 사용합니다.
  • Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
  • Resolves: 이슈를 해결했을 때 사용
  • Ref: 참고할 이슈가 있을 때 사용
  • Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

예시

1. git 명령어 입력

git add .
git commit

git commit -m "<< 메시지 >>"를 입력하여도 되지만 여러 줄을 입력할 때는 git commit으로 메시지를 작성하는 것이 편리합니다.

git commit을 입력하면 vi 에디터 형식으로 입력할 수 있게 됩니다.

2. 커밋 메시지 작성

Feat: 사용자 인증 기능 구현

- OAuth 연동
- 회원가입과 로그인 로직 구현
- 로그인, 회원가입 폼 컴포넌트 구현

Fixes: #13
Resolves: #11, #12
Ref: #10
Related to: # 14

3. git push

git push origin << 브런치명 >>

참고

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