Commit Convention

Commit Message Convention

프로젝트의 커밋 메시지를 일관성 있고 명확하게 작성하기 위해 아래와 같은 구조로 커밋 메시지를 작성합니다.
이 Convention은 각각의 커밋이 어떤 작업을 수행하는지를 명확히 전달하여 협업과 버전 관리를 원활하게 합니다.

구조

종류	내용	예시
Emonji	아이콘	✨
타입	제목	feat:
본문	변경 내용	검색 기능 추가
번호	이슈 번호	#1

(예시) git commit -m "✨ feat: 검색 기능 추가 #1"

타입 및 Emonji

타입	Emonji	타이핑	뜻
feat	✨	:sparkles:	새로운 기능 추가
fix	🐛	:bug:	버그 수정
design	📱	:iphone:	사용자 UI 디자인 변경
style	🎨	:art:	코드 포맷 변경, 세미 콜론 누락, 코드 수정 없음
refactor	♻️	:recycle:	프로덕션 코드 리팩토링
comment	💡	:bulb:	주석 추가 및 변경
docs	📝	:memo:	문서 수정
test	✅	:white_check_mark:	테스트 추가 또는 리팩토링
chore	🏗️	:building_construction:	파일이나 폴더명 변경, 이동 작업만
rename	🚚	:truck:	파일이나 폴더명 변경, 이동 작업만
remove	➖	:heavy_minus_sign:	파일 삭제 작업만
!BREAKING CHANGE	👽️	:alien:	커다란 API 변경
!HOTFIX	🔥	:fire:	급하게 치명적인 버그 수정

주의사항

• 커밋 메시지는 명료하고 간결하게 작성하는 것이 좋습니다.
• 커밋 타입과 내용을 일광성 있게 작성하여 프로젝트의 커밋 로그를 쉽게 읽을 수 있도록 합니다.
• 이슈를 참조하는 경우 이슈 번호를 커밋 메시지에 포함시키는 것이 유용합니다. 이를 통해 이슈와 관련된 커밋을 추적할 수 있습니다.