Git-Convention.md

Git Convention

다음 순서로 커밋 메시지 템플릿을 구성하고, 개발 시 사용합니다.

Commit Type

제목			설명
feat			새로운 기능을 추가
fix			버그 수정
design			CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE			커다란 API 변경의 경우
!HOTFIX			급하게 치명적인 버그를 고쳐야하는 경우
style			코드 포맷 변경, 세미 콜론 누락
refactor			코드 리팩토링
comment			필요한 주석 추가 및 변경
docs			문서 추가 삭제 수정
test			테스트 코드 추가
chore			빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트
rename			파일 혹은 폴더명을 수정하거나 옮기는 작업
remove			파일을 삭제하는 작업

Template 생성

1. .gitmessage.txt 파일을 생성

2. 아래 내용 추가

   ################
   # <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
   # 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
   # 예) feat : 로그인 기능 추가
   
   # 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
   
   ################
   # 본문(구체적인 내용)을 아랫줄에 작성
   # 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
   
   ################
   # 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
   # 예) Close #7
   
   ################
   # feat : 새로운 기능 추가
   # fix : 버그 수정
   # docs : 문서 수정
   # test : 테스트 코드 추가
   # refact : 코드 리팩토링
   # style : 코드 의미에 영향을 주지 않는 변경사항
   # chore : 빌드 부분 혹은 패키지 매니저 수정사항
   ################
   

3. git config --global commit.template .gitmessage.txt 명령어를 입력한다.