Commit Convention

Commit Messge 구조

커밋 메시지는 제목 파트만 적용하며 한글로 작성한다.

type: subject ⭕️
body ❌
footer ❌

Commit Type

타입의 첫 문자는 소문자로 작성한다.

feat: 버튼 컴포넌트 구현

Type	Description
feat	새로운 기능 추가
fix	버그 수정
refactor	코드 리팩토링
style	코드 스타일, 포맷팅 수정
docs	문서(주석) 추가 및 수정
chore	패키지 매니저 수정 ex) .gitignore
design	UI 스타일 파일 추가 및 수정
build	빌드 관련 파일 수정
remove	파일 삭제
ci	CI관련 수정
test	테스트 코드 추가 및 수정
release	버전 릴리즈

Subject

제목은 최대 50글자가 넘지 않도록 하고 특수기호 및 이모지를 사용하지 않는다.

명령형으로 작성한다.

Commit 단위

커밋 단위를 고려하여 작성한다.

커밋 1: UI 구현 + SCSS 스타일
커밋 2: utils
커밋 3: hooks

• UI 구현 + SCSS 스타일 하나의 커밋으로 묶어서 작성한다.
• 이외의 파일은 다른 커밋 단위로 적용한다.

Commit 할 때 주의할 점

git add . 와 같이 한 번에 커밋 하려는 행동을 지양한다.

스테이징 된 파일은 한 번 더 확인 후 커밋한다.

❌ 안 좋은 커밋

feat: "커스텀 훅 생성"

⭕️ 좋은 커밋

feat: "토글 관련 전역 커스텀 훅 생성"

tool 사용하지 않고 vscode terminal을 사용하여 커밋한다.