Skip to content

커밋 컨벤션

peeerr edited this page Nov 14, 2024 · 1 revision

커밋 타입

타입 설명
init 프로젝트 생성 및 초기 세팅
feat 기능 구현 및 변경 작업
refactor 기능은 그대로 유지한 채 코드 개선
test 테스트 코드 작성 및 수정
fix 버그 수정
clean 불필요한 코드 제거
style 코드 컨벤션에 맞춰 코드 포맷팅
docs 문서화 작업
chore 의존성 추가, 버전 업데이트 등 빌드 관련 작업
remove 파일 또는 패키지 삭제
rename 파일 또는 패키지 재작명 혹은 위치 이동
perf 성능 향상을 위한 코드 수정 및 최적화

커밋 메시지 기본 형식

<타입>: <제목>

- <본문>
- <본문>
...

예시

refactor: 일기 조회 기능의 데이터 필터링 로직 개선

- 필터링 로직을 별도의 서비스 클래스로 분리하여 코드의 모듈화와 유지 보수성을 향상시켰습니다.
- 중복된 필터링 코드와 쿼리 로직을 함수로 추출하여 재사용성을 높였습니다.

커밋 메시지 규칙

커밋 타입

  • 영문으로 작성하고, 소문자로 작성

커밋 메시지 제목

  • 한국어로 작성

  • 50자 이하로 제한

커밋 메시지 본문

  • 한국어로 작성

  • 72자 이하로 제한

  • 제목과 본문 사이에 빈 줄 하나 존재

  • 제목만으로도 어떤 작업인지 파악 가능하게 작성, 필요시에만 본문 추가

  • 본문은 변경 사항의 What과 Why에 초점

  • 여러 내용은 대시(-) 사용하여 구분