프로젝트를 할 때 commit 메세지를 어떻게 작성할지 고민해 본적이 있었습니다.
물론 그 고민은 오래가지 않았고 그 당시에 가장 깔끔하고 알아보기 쉽다고 생각하는 메세지를 적었습니다.
하지만 나중에 commit 메세지들을 보면 언제나 알아보기 힘들었습니다 ㅎㅎㅎ.. 😥
때문에 협업을 위해서 commit 메세지를 규칙적으로 작성하는 연습을 하고자 합니다!!😀
규칙적인 커밋 메세지 작성 시 장점😁
- commit log의 가독성 향상
- 협업과 리뷰등 커뮤니케이션 향상
- 코드 추적, 유지보수능력 향상
커밋 메세지의 7가지 규칙🔍
-
제목과 본문을 빈 행으로 구분
-
제목을 50글자 내로 제한
-
제목 첫 글자는 대문자로 작성
-
제목 끝에 마침표 넣지 않기
-
제목은 명령문으로 사용하며 과거형을 사용하지 않기
-
본문의 각 행은 72글자 내로 제한
-
어떻게 보다는 무엇과 왜를 설명
커밋 메세지의 구조
<type>(<scope>): <subject> -- 헤더
<BLANK LINE> -- 빈 줄
<body> -- 본문
<BLANK LINE> -- 빈 줄
<footer> -- 바닥 글
<type>은 해당 commit의 성격을 나타냅니다.
feat : 새로운 기능에 대한 커밋
fix : build 빌드 관련 파일 수정에 대한 커밋 build : 빌드 관련 파일 수정에 대한 커밋
chore : 그 외 자잘한 수정에 대한 커밋(rlxk qusrud)
ci : CI 관련 설정 수정에 대한 커밋
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor : 코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋<body>은 본문으로 상세한 내용을 작성합니다.
단 헤더로 충분히 표현했다면 생략 가능합니다.
<footer>은 바닥글로 참조 정보들을 추가하는 용도로 사용합니다.
참고 사이트
https://beomseok95.tistory.com/328
https://xtring-dev.tistory.com/entry/Git-%EA%B7%9C%EC%B9%99%EC%A0%81%EC%9D%B8-Commit-%EB%A9%94%EC%84%B8%EC%A7%80%EB%A1%9C-%EA%B0%9C%EB%B0%9C%ED%8C%80-%ED%98%91%EC%97%85%ED%95%98%EA%B8%B0-%F0%9F%91%BE
꾸준함, 책임감