커밋 컨벤션

프로젝트 식샤를 합시다 서버팀의 커밋 컨벤션

커밋 템플릿

• 아래의 템플릿을 참고하여 작성한다.

    (type) : subject #Jira Issue
           
             body

• ex ) (chore) : .gitignore 수정 #EAT-1 .properties 파일을 깃 추적 대상에 추가함

커밋 메세지 설명

1. type
   • 타입은 소문자로 작성하며, 소 괄호로 감싼다.
   • 종류
     • feat : 새로운 기능 추가
     • fix : 버그 수정
     • docs : 문서 수정(readme.md 등)
     • style : 코드 포맷팅, 세미콜론 누락 등의 코드 변경이 없는 경우
     • refactor : 코드 리펙토링
     • test : 테스트 코드 추가, 수정, 삭제 등 비즈니스 로직 변경이 없는 경우
     • chore : 위의 경우에 걸리지 않는 변경 사항, 빌드 업무 수정 등(.gitignore 수정, build.gradle)
     • comment : 주석 추가 및 수정
     • rename : 파일 및 폴더 명 수정
     • remove : 파일 및 폴더 삭제
2. subject
   • 알아보기 쉽게 한글로 작성
   • 영어로 작성할 시, 첫 글자 대문자로 표기하도록 한다.
   • 간결하고 요점만 서술할 수 있도록 한다.
3. body
   • 최대한 상세하게 작성한다
   • 어떤 내용이 변경되었는지 보다는 '무엇을', '왜' 변경 했는지 작성하도록 노력한다.