[git&github] Commit convention

💻 Commit convention

협업시 커뮤니케이션 비용을 줄일 수 있는 Commit convention에 대해 알아보자. 일반적인 형태는 다음과 같다.

[commit type] : subject
body(자세한 설명)
footer(부가 정보)

💻 예시

[FEAT] : ToDoList Add

ToDoList가 추가되는 기능을 구현하였습니다.

TextInput에 텍스트를 작성합니다
Button 클릭 시 해당 텍스트가 ToDoList에 저장됩니다.

Resloves(해결됨) : #3
Ref(참고이슈) : #1

💻 Commit Type

Tag	Description
[FEAT]	기능 개발 및 기능 추가
[FIX]	버그 수정
[DESIGN]	UI 디자인 변경
[BREAKING CHANGE]	커다란 API 변경의 경우(URI 주소 외 Request, Response 가 변경되는 경우)
[HOTFIX]	급하게 치명적인 버그를 고쳐야하는 경우
[STYLE]	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
[REFACTOR]	코드 리팩토링
[MERGE]	병합
[CONFLICT]	병합 시 충돌 해결
[DEPLOY]	배포 관련 커밋
[REMOVE]	파일을 삭제하는 작업만 수행한 경우
[RENAME]	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
[UPDATE]	업데이트
[TEST]	테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음

💻 Footer 예시

Tag	Description
Fixes:	이슈 수정중 (아직 해결되지 않은 경우)
Resolves:	이슈를 해결했을 때 사용
Ref:	참고할 이슈가 있을 때 사용
Related to:	해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

💻 Git Commit template plugin (IntelliJ)

IntelliJ IDEA의 Git Commit template plugin을 사용해보자

💻 출처

스파르타코딩클럽