[Git] git 커밋 메시지 규칙

Git 커밋 메시지를 작성할 때는 일관된 규칙을 따르는 것이 중요하다.

이는 프로젝트의 유지보수성과 협업의 효율성을 높이는 데 도움이 되며, 나 또한 쉽게 찾아볼수있도록 정리하고자한다.

 

다음은 일반적으로 많이 사용되는 Git 커밋 메시지 규칙이다.

1. 커밋 메시지 구조

<타입>: <제목>

<본문>

<푸터>

 

2. 커밋 메시지 타입

타입은 커밋의 목적을 명확하게 나타내며, 다음과 같은 타입이 자주 사용된다.

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 변경
• style: 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 경우
• refactor: 코드 리팩토링 (기능 변경 없음)
• test: 누락된 테스트 추가 또는 기존 테스트 수정
• chore: 빌드 프로세스 또는 보조 도구 수정 (라이브러리 추가 등)
• perf: 성능 향상 관련 변경
• build: 빌드 관련 파일 변경
• ci: ci 관련 설정 변경

3. 제목 작성 규칙

• 제목은 50자 이내로 간결하게 작성
• 첫 글자는 대문자로 시작
• 마침표를 사용하지 않음
• 명령문 형태로 작성 (예: "Add feature", "Fix bug")

4. 본문 작성 규칙

• 본문은 선택 사항이며, 변경 사항에 대한 추가 설명이 필요할 때 작성
• 제목과 본문 사이에 빈 줄을 추가하여 구분
• 각 행은 72자 이내로 작성
• "무엇"을 "왜" 변경했는지 설명한다. "어떻게" 변경했는지는 코드에서 드러나므로 설명하지 않아도 된다.

5. 푸터 작성 규칙

• 푸터는 선택 사항이며, 이슈 추적 번호나 브레이킹 체인지 등을 명시할 때 사용
• 예시:
  • BREAKING CHANGE: 설명
  • Closes #123

예시

feat: 사용자 로그인 기능 추가

- 사용자 인증을 위해 JWT 사용
- 로그인 API 엔드포인트 추가
- 로그인 페이지 UI 구현

Closes #45

 

fix: 로그인 오류 수정

- 잘못된 비밀번호 입력 시 오류 메시지 표시
- 세션 만료 시 자동 로그아웃 기능 추가