밍개발일지

커밋 컨벤션

미미_밍 2024. 12. 30. 16:05

✔️커밋컨벤션

- [Feat] 새로운 기능 추가

- [Fix] 버그 수정

- [Docs] 문서 수정

- [Style] 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)

- [Design] 사용자 UI 디자인 변경 (CSS 등)

- [Test] 테스트 코드, 리팩토링 (Test Code)

- [Refactor] 리팩토링 (Production Code)

- [Build] 빌드 파일 수정

- [Ci] CI 설정 파일 수정

- [Perf] 성능 개선

- [Chore] 자잘한 수정이나 빌드 업데이트

- [Rename] 파일 혹은 폴더명을 수정만 한 경우

- [Remove] 파일을 삭제만 한 경우

✔️커밋 예시

Feat: 회원 가입 기능 구현

SMS, 이메일 중복확인 API 개발

Resolves: #123
Ref: #456
Related to: #48, #45

✔️커밋규칙

  1. 제목과 본문은 한 줄을 띄워서 작성한다.
  2. 제목은 영문 기준 50자 이내로 작성한다.
  3. 제목 첫글자는 무조건 대문자로 작성한다.
  4. 제목 끝에 마침표(.)는 찍지 않는다.
  5. 제목은 개조식 (영어라면 명령문) 으로 작성한다. (Update code, Fix bug 등으로만 작성, 만약에 한글로 작성한다면 ‘abc 함수 수정’ 과 같은 식으로)
  6. 본문은 무엇을 에 맞춰서 작성한다.
  7. "유형: 이슈번호" 형식으로 작성
  8. 유형은 “Close, Fix, Resolve” 등을 활용 (보통 Close 는 일반 개발 이슈를 닫을 때, Fix 는 버그 이슈를 닫을 때, Resolve 는 문의나 요청사항에 대한 이슈를 닫을 때 사용합니다.)
  9. Fixes: 해당 이슈 수정중 (아직 해결되지 않은 경우)Ref: 참고할 이슈가 있을 때 사용
  10. Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
  11. Resolves: 해당 이슈를 해결했을 때 사용