Commit Convention - codestates/pomodoro GitHub Wiki

👉 Commit Convention

Commit Header

• {commit header}: {commit title} (#{issue number})

Commit Body

커밋 메시지는 제목과 본문으로 나누어 집니다. 한 줄만 작성해도 설명이 충분하다면 제목만으로도 괜찮습니다. 하지만 어떤 변경 사항이 있는지 맥락과 설명이 필요하다면 본문을 작성할 수 있습니다. 다음은 제목과 본문을 작성하는 규칙입니다.

1. 제목과 본문을 한 줄 띄워 분리해 주세요.
2. 제목은 50자 이내로 적어주세요.
3. 제목 첫글자를 대문자로 적어주세요.
4. 제목 끝에 . 는 금지합니다.
5. 제목은 명령어로 작성합니다.
6. 본문은 50자마다 줄을 바꿔주세요.
7. 본문은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성하세요.

• EX )

✨feat: Something (#1)
- body1
- body2

Commit header 종류	이모지	Commit 타입	설명
New Feature	✨:sparkles:	feat:	새로운 기능에 대한 커밋
Fix	:wrench::wrench:	fix:	기능 수정에 대한 커밋
Bug	🐞:bug:	bug:	버그 관련에 대한 커밋
Working In Process	⚙:gear:	wip:	진행 중인 사항에 대한 커밋
Refactor Code	:broom: :broom:	refactor:	코드 문법, 포맷(prettier) 등 리팩토링에 대한 커밋
Documentation	📚 :books:	docs:	도큐먼트 수정에 대한 커밋
Styling UI	🎨:art:	style:	HTML, CSS, 오타 수정에 대한 커밋
Package Manager	:key::key:	build:	패키지 매니저 설정할 경우
Test Code	:hourglass::hourglass:	test:	누락된 테스트 추가 또는 기존 테스트 수정
Revert	:leftwards_arrow_with_hook::leftwards_arrow_with_hook:	revert:	작업 되돌리기