Github commit convention

Commit Type

커밋구분	설명
Feat	(feature)개선 또는 기능 추가
Fix	(Bug Fix)버그 수정
HOTFIX	급하게 치명적인 버그 수정이 필요한 경우
Docs	(Documentation)문서 작업
Test	(Test) 테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
Build	(Build)빌드 프로세스 관련 수정(ex : yml)
Refactor	프로덕션 코드 리팩토링
Clean	(Cleanup) 코드 정리 / 리팩토링
Design	CSS 등 사용자 UI 디자인 변경
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우

Title

제목은 50글자 이내로 작성한다. 첫글자는 대문자로 작성한다. 마침표 및 특수기호는 사용하지 않는다. 영문으로 작성하는 경우 동사(원형)을 가장 앞에 명령어로 작성한다.

Body

최대한 상세히 작성한다. (코드 변경의 이유를 명확히 작성할수록 좋다) 어떻게 변경했는지보다 무엇을, 왜 변경했는지 작성한다.

Footer

선택사항 issue tracker ID 명시하고 싶은 경우에 작성한다. 유형: #이슈 번호 형식으로 작성한다. 여러 개의 이슈번호는 쉼표(,)로 구분한다. 이슈 트래커 유형은 다음 중 하나를 사용한다. Fixes: 이슈 수정중 (아직 해결되지 않은 경우) Resolves: 이슈를 해결했을 때 사용 Ref: 참고할 이슈가 있을 때 사용 Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

예시

Feat: 회원 가입 기능 구현

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

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