[Git] git commit 메시지 규칙

메시지 규칙 사용 이유

• 좋은 가독성
• 유지보수 시 빠르게 찾기 위함
• 통일된 양식 사용으로 협업 능력 향상

 

커밋 유형

type(타입) - Subject(제목)

Body(본문)

Footer(꼬릿말)

 

타입 종류

• Feat              : 새로운 기능 추가
• Fix                 : 버그 수정
• Docs             : 문서 수정
• Style             : 스타일 관련 기능 (코드 포맷팅*, 코드 자체의 변경이 없는 경우)
• Refactor       : 코드 리팩토링
• Test              : 테스트 코드 추가
• Chore           : 빌드 업무 수정, 패키지 매니저 수정(.gitignore 수정)  
• Comment     : 필요한 주석 추가 및 변경
• !Hotfix          : 급한 치명적 버그 수정
• Rename       : 파일, 폴더명 수정, 옮길 경우
• Remove      : 파일 삭제 작업
• Design        : UI, CSS 디자인 변경

 

* 코드 포맷팅 : 문자열 안에 특정한 값을 삽입하는 방법 

- 특정 값, 변수등을 문자열에 입력하거나 문자열이 변수의 값에 의해 바뀌어야 하는 상황

- 변수에 있는 값을 문자열로 사용할 때 사용하는 방법

 

꼬릿말

• Resolve          : 해결한 이슈 번호
• Relate             : commit 과 관련된 이슈 번호
• Ref                  : 참고할 이슈 번호
• Fixes               : 이슈 수정중 (미해결)

예시

Feat : 회원가입 구현(#123)

회원가입 구현
- SignUp.java : 사용자 요구로 회원가입 구현

Resolve : #123
Related to : #456
Ref : #789, #555