Home

Commit Convention

[type]: [subject] - [Issue #num]

예시

CONFIG: 환경설정 - Issue #1

[type] : commit의 타입 대문자 -> FEAT / HOTFIX / DEV / CONFIG

[subject] : commit의 제목 -> 기능

[Issue] : 이슈 연결

• 제목과 본문은 한 줄을 띄워 분리합니다
• 제목은 간략하게 간추립니다 (기왕이면 50자이내)
• 제목 끝에 .금지

type 종류

type	종류
FEAT	새로운 기능 추가
HOTFIX	버그 수정
DOCS	문서 수정
REFACTOR	코드 리팩토링
CONFIG	패키지 매니저 등 빌드 관련 설정 수정
TEST	테스트 코드 작성
CHORE	그외 자잘한 수정 및 설정

좋은 git 커밋 메시지를 작성하기 위한 8가지 약속

Issue #num

- Issue #13    # 평소 커밋시 사용 - 기능에 해당하는 이슈에 연결 

- Close #14    # 이슈를 닫을 때 (일반 개발 이슈)
- Fix #15    # 이슈를 닫을 때 (버그 픽스 이슈)
- Resolve #16    # 문의나 요청 사항 대응

해당 구문이 commit에 들어가면 github이 자동으로 인식해 이슈를 종료합니다.

코드 컨벤션

JAVA -> 전부 Camel
SQL,JSON -> 전부 Snake