[깃(git),깃허브(github)] - 커밋 메시지

커밋 메시지 구조

커밋 메시지는 일반적으로 세 부분으로 구성

• 제목 (필수)

  • 50자 이내로 작성
  • 첫 글자는 대문자로 시작
  • 마침표로 끝내지 않음

• 본문 (선택)

  • 변경 이유와 변경 내용을 상세히 설명
  • 72자 단위로 줄바꿈
  • 어떻게 보다는 무엇을, 왜 변경했는지 설명

• 푸터 (선택)

  • 관련 이슈 번호나 기타 메타데이터 포함

커밋 타입

커밋 메시지 제목에는 다음과 같은 타입을 사용 가능

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 포맷팅, 세미콜론 누락 등 스타일 관련 변경
• refactor: 코드 리팩토링
• test: 테스트 코드 추가 또는 수정
• chore: 빌드 작업, 패키지 매니저 설정 등 잡다한 작업
• perf: 성능 개선
• ci: CI 설정 파일 및 스크립트 변경
• build: 빌드 시스템 또는 외부 종속성 관련 변경
• revert: 이전 커밋 되돌리기

커밋 메시지 작성 팁

• 명확하고 간결하게 작성: 변경 사항을 정확히 설명하되, 불필요한 세부 사항은 제외
• 현재 시제 사용: "Fixed bug"가 아닌 "Fix bug"로 작성
• 능동태 사용: "Changed"보다는 "Change"를 사용
• 왜 변경했는지 설명: 특히 큰 변경사항의 경우, 변경 이유를 명확히 설명
• 관련 이슈 언급: 해당 커밋이 특정 이슈와 관련있다면 이슈 번호를 포함시킴

예시

feat: 사용자 인증 기능 추가

JWT를 사용한 사용자 인증 기능을 구현
- 로그인 및 회원가입 엔드포인트 추가
- 프론트엔드에서 인증 처리 로직 업데이트

Resolves: #123

참고 : git-commit-message-best-practices