-
Notifications
You must be signed in to change notification settings - Fork 0
Commit Convention
Mintaek Kim (Meenu) edited this page Oct 24, 2022
·
2 revisions
- commit message는 커밋타입:깃모지이름:: #이슈번호 제목 의 형태로 작성한다.
- ex) Feat:sparkles:: #12 Add Connect API class
- 제목은 50자 이내로 작성하며, 변경사항이 무엇인지 명확하게 작성한다.
- 제목의 끝에는 마침표를 사용하지 않는다.
- 제목은 반드시 영어만 사용하여 작성한다.
- commit message의 본문에는 한글을 사용한다.
- 본문에는 변경사항에 대해 자세하게 작성한다.
- 본문을 여러 줄로 작성할 때에는
-
로 구분하며, 본문의 한 줄은 최대 72자 이내로 작성한다. - 타입의 첫 글자는 반드시 대문자로 작성하며, 타입의 뒤에 깃모지(:깃모지이름:)를 같이 사용한다.
- Commit은 Task를 최대한 잘게 쪼개서 올리도록 한다.
Commit Type | 설명 | 사용 예시 | 깃모지이름 |
---|---|---|---|
Feat✨ | 새로운 기능 추가 | sparkles | |
Fix🐞 | 버그 수정 | beetle | |
Docs📚 | 문서 수정 | books | |
Style🎨 | 코드의 의미에 영향을 주지 않는 변경 사항 | 포매팅, 세미콜론 빠졌을 때, 공백 등 | art |
Comment💡 | 필요한 주석 추가 및 변경 | bulb | |
Refactor♻️ | 코드 리팩토링 | recycle | |
Rename📝 | 파일 혹은 폴더명을 수정하거나 옮기는 작업만 하는 경우 | pencil | |
Remove🔥 | 파일을 삭제하는 작업만 수행한 경우 | fire | |
Chore🔧 | src 또는 테스트 파일을 수정하지 않는 기타 변경사항 | wrench | |
!HOTFIX🚑 | 급하게 치명적인 버그를 고쳐야 하는 경우 | ambulance |
copyrightⓒ 2022 All rights reserved by taek0622