Git Commit Message Rule

 

 

 

목적이나 내용을 쉽게 파악할 수 있도록

 

type: 제목 

본문 

close/fix/resolve: #1 
ref: #2 
related to: #3

 

한 줄 공백으로 구분된 제목, 본문, 꼬리말 구성 (본문과 꼬리말은 필요한 경우에만)

• 한 줄 공백을 사용하면 git log —oneline, git shortlong와 같은 명령어에서 보다 유용한 커밋 메세지가 될 수 있음

제목

type의 종류

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 관련
• refactor: 코드 리팩토링
• test: 테스트 코드
• chore: 빌드 업무 수정, 패키지 매니저 수정 등
• add: 기능도 아니고 문서도 아니고 애매한 뭔가를 추가할 때
• delete: 삭제
• update: 버전 업데이트
• rename: 이름 변경
• move: 코드나 파일 이동
• modify: 수정
• correct: 문법 오류, 타입 변경, 오타 등

본문

제목에 대한 부연 설명

어떻게 보다 무엇을, 왜 변경했는지에 집중하여 작성

꼬리말

이슈를 자동으로 종료하고, 필요한 경우 관련 이슈, 참고 이슈에 대한 정보 작성

• close - 일반 개발 이슈
• fix - 버그 픽스나 핫픽스 이슈
• resolve - 문의나 요청사항에 대응한 이슈

---

참고 사이트

https://meetup.toast.com/posts/106

https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

https://doublesprogramming.tistory.com/256

https://mingnol2.tistory.com/129