Git commit Convention

Commit Convention

Commit Title 설명

• feat: 기능 추가 및 수정
• design: 레이아웃 추가 및 수정
• fix: 버그 수정
• test: 테스트 코드 추가 및 수정
• setting: 환경 설정
• docs: 문서 추가 및 수정
• refactor: 코드 리팩토링
• style: 주석, 프리티어 등 기능의 영향없이 코드의 모양새만 바뀌는 경우
• ci/cd: CI/CD 관련 변경
• perform: 성능 변화를 목적으로 코드 추가 및 수정
• chore: 기타 업무 유형의 내용

Commit Title

커밋 타입(코드 계층) : 커밋 메세지 (#이슈번호)

- 좋은 예시) feat(controller) : 깃허브 로그인 버튼 컴포넌트 구현 (#13)

- 나쁜 예시) feat: 로그인 구현

커밋 메세지 작성 방식

• 커밋 타입 : 소문자 영단어로 작성
• 커밋하는 코드의 계층: controller, service, repository, dto 등의 내용 작성
• 커밋 메세지 제목 : 명령형으로 작성, 마침표로 끝나지 않음
• 이슈번호 : 커밋과 관련된 이슈 번호 작성

Commit Unit

• 커밋 메시지를 기준으로 작성
• 하나의 커밋에는 하나의 작업단위만 작업
• 한 커밋이 너무 많은 파일을 수정하는 것을 지양 (제대로 확인이 되지 않음)