Skip to content

커밋메시지

dreamchach edited this page Mar 6, 2023 · 2 revisions

커밋메시지 구조

type(커밋메시지 타입) : subject(커밋 제목)

body(커밋 본문)

footer(이슈 관련)

commit type(커밋메시지 타입)

첫 문자는 대문자로 작성

  1. Feat : 새로운 기능 추가
  2. Fix : 버그 수정
  3. Docs : 문서 수정
  4. Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  5. Refactor : 코드 리펙토링
  6. Test : 테스트 코드, 리펙토링 테스트 코드 추가
  7. Chore : 빌드 업무 수정, 패키지 매니저 수정
  8. Env : 개발 환경 관련 설정
  9. Design : CSS등 디자인 추가/수정
  10. Comment : 주석 추가/수정
  11. Rename : 파일 및 폴더명 수정
  12. Remove : 파일 삭제

commit subject(커밋 제목)

  • 마침표 및 특수기호를 사용하지 않는다.
  • 영어로 작성하고, 동사를 가장 앞에 두고, 첫 글자를 대문자로 표기한다.

commit body(커밋 본문)

  • 무엇을 변경했는지, 왜 변경했는지를 설명한다.

commit footer(이슈 관련)

  • 필수 작성이 아니다.
  • "유형: #이슈 번호" 형식으로 작성한다.
  • 이슈 트래커 유형은 다음과 같다.

이슈 트래커 유형

  1. Fixes : 이슈 수정 중 (아직 해결되지 않은 경우)
  2. Resolves : 이슈를 해결했을 때 사용
  3. Ref : 참고할 이슈가 있을 때 사용
  4. Related to : 해당 커밋과 관련된 이슈번호 (아직 해결되지 않은 경우)

commit 예시

Feat: Make login funtion

로그인 기능 개발

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