Commit Convention

Commit Convention

Udacity Git Commit Message Style Guide와 gitmoji를 참고하여 작성하였으나, 작성자(@jun108059)가 사용하기 편하게 수정한 convention입니다.

Commit 메시지 구조

Type Subject

Body 

Footer

Type

gitmoji를 참고하여 Type을 이모지로 대체합니다.

emoji	설명	emoji	설명
🎉	프로젝트 시작	♻️	Refactoring
📝	문서	🚚	구조, 경로 변경
👔	비즈니스 로직	👷️	CI
🗃️	데이터베이스	🚀️️	CD
🧱️	인프라	⚡️️	성능개선
💡️	주석	🚑️	핫픽스
✅	테스트	🐛	버그 해결
➕️	의존성 추가	🔀	브랜치 Merge
➖️	의존성 제거	🔖	릴리스
🔧	설정 파일	🔊	로그 추가 삭제
🔥	코드/파일 삭제	🔐	보안키 관련 수정
🚧	Work In Progress	✨	새로운 기능
💄	UI와 style 파일 관련	💚	Fix CI Build

Subject

• 길이는 50자 이하로 작성합니다.
• 첫 글자는 대문자로 작성합니다.
• 끝에는 마침표를 붙이지 않습니다.
• 명령형을 사용하여 커밋합니다.

Body

• body 작성은 선택사항입니다.
• Subject과 body 사이에는 빈 줄(new line)이 있어야 합니다.
• 길이는 72자 이내로 제한합니다.
• What과 Why를 작성합니다.(How제외)

Footer

• footer 작성은 선택사항입니다.
• Issue tracker ID를 명시합니다.
• footer-type: #Issue nubmer형식으로 작성합니다.
• 여러개의 Issue 번호가 있는 경우 쉼표로 구분합니다.

footer-type 종류

1. Related to: 진행중인 이슈
2. Resolves: 이슈 해결
3. See also: 참고할 이슈