Commit Convention

Commit convention

Pre Commit

커밋 전에 npm run format로 프리티어를 실행하고 커밋하기

Commit message convention

type: 제목
(두 줄 띄워 분리)
body
(두 줄 띄워 분리)
footer

공동 작업자

// body 맨 위에
Co-authored-by: hhnn0 <[email protected]>
Co-authored-by: jhj9109 <[email protected]>
Co-authored-by: jis8140 <[email protected]>
Co-authored-by: ingyobot <[email protected]>

Commit Types

feat - 새로운 기능 추가
fix - 버그를 고친 경우
design - css 등 사용자 UI 디자인 변경
style - 코드 포맷 변경, 세미 콜론 누락 등
refactor - 리팩토링
comment - 주석 추가 및 변경
docs - 문서를 수정한 경우
test - 테스트 추가, 테스트 리팩토링
chore - 빌드 태스크 업데이트. 패키지 매니저를 설정하는 경우
rename - 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove - 파일을 삭제하는 작업만 수행한 경우
!breaking change - 커다란 API 변경, DB 테이블 변경, 급하게 치명적인 버그를 고쳐야 하는 경우
!hotfix - 핫픽스
merge - FE, BE 공동으로 작업하는 경우

commit title

• 제목의 처음은 동사 원형으로 시작
• 영어로 작성하는 경우 'Fix', 'Add', 'Change'
• 한글로 작성하는 경우 '고침', '추가', '변경' 등의 명령어로 시작

commit body

• 본문의 내용은 어떻게 변경했는지 보다 무엇을, 왜 변경했는지 설명
• 양에 구애받지 않고 최대한 상세히 작성

commit footer

• '유형: # 이슈 번호' 형식으로 작성
• 여러개의 이슈 번호를 적을 때는 쉼표로 구분
• 'fixes: #45 related to: #34, #23' 형식으로 작성

commit footer types

fixes: 이슈 수정 중(미완일 경우)
resolves: 이슈를 해결했을 경우
ref: 참고할 이슈가 있을 경우
related to: 해당 커밋에 관련된 이슈 번호(미완일 경우)