[Git / Github] git commit message guide

🔥 목적

Commit Message를 통해 추가/수정사항에 커밋 메시지만으로 파악이 가능하고, 빠르게 원하는 커밋 내용을 확인하고 파악하게 함

🔥 메시지 구조

type: [#issueNumber - ]Subject

Body

Footer

📝 제목(Subject)

• 필수. 반드시 타입과 함께 작성
• type: [#issNumber - ]Subject형태로 작성
• 제목은 최대 50자를 넘지않도록 주의
• 해당 커밋에 대한 주요 내용을 간략하게 기록

  타입(type)의 종류

  • feat : 새로운 기능 추가, 기존의 기능 변경
  • fix : 버그 수정
  • docs : 문서(주석) 추가/수정
  • style : UI추가/변경, 스타일 관련 작업, 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  • refactor : 코드 리팩도링(기능 변화X)
  • test : 테스트 코드, 리팩토링 테스트 코드 추가
  • chore : 빌드 업무 수정, 패키지 매니저 수정

📝 본문(Body)

• 커밋에서 수정된 상세내역 작성. 평서문
• 생략 가능. 제목라인과 반드시 한 줄
• 한 줄에는 72자 이하로 작성, 길어질 경우 개행
• '무엇을 왜'에 맞춰 작성

📝 꼬리말(Footer)

• 해당 커밋과 연관된 이슈 트래킹 번호를 입력
• 제목에는 커밋이 온전히 한 개의 이슈에 해당하는 경우에만 추가, 그 외의 경우 꼬리말에 라벨과 함께 이슈 번호 추가
• 생략 가능. 반드시 제목 또는 본문라인과 한 줄

  라벨의 종류

  • Resolve : 문의, 요청에 의한 이슈에 해당하는 경우
  • Closes : 일반적인 개발과 관련된 이슈에 해당하는 경우
  • Fixes : 버그 픽스, 핫 픽스 관련 이슈에 해당하는 경우
  • See alse : 커밋의 이슈와 연관되어 있는 이슈들이 존재하는 경우

• 예시

Resolves: #1234
See also: #1234, #1236

Reference

https://blog.munilive.com/posts/my-git-commit-guide.html