Commit Convention

git hook을 사용해 코드를 커밋하기 전 commitlint로 커밋 컨벤션을 검사합니다.

커밋 컨벤션은 commitlint의 룰을 따릅니다.

🎗Git Convention🎗

<type>(<scope>): <subject>

Type

• feat : 새로운 기능 추가, api변경
• fix : 버그 수정, api 변경 없이 내부 수정
• docs : 문서 수정
• style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• refactor : 코드 리펙토링
• test : 테스트 코드, 리펙토링 테스트 코드 추가
• chore : 빌드 업무 수정, 패키지 매니저 수정, 그외 자잘한 수정사항들

scope

commit이 생긴 장소. scope를 보았을 때 어디서 작업한 내용인 지 한번에 볼 수 있도록 작성합니다. (너무 길어지지 않도록 합니다.)

예) fix(client/reservation_page)

subject

내가 무엇을 끝냈는지에 대해 명령조로 작성합니다.

body

subject의 내용 + commit 내용에 대한 이유. 이전의 내용과의 대조 등을 자세히 작성합니다.

footer

issue 참조, issue close #(issueNum) issue close keywords : closes #(issueNum)