[Git] 커밋 메시지 컨벤션

레고·2022년 11월 29일
0

몰랐다. 나는 컨벤션. 있는 줄도.

우테코 프리코스를 진행하면서 지난 날들의 내가 부끄러웠던 포인트가 몇몇 있었다. 그 중에서도 가장 부끄러웠던 부분은 다름 아닌 깃 커밋 메시지에도 룰이 있었다는 것...🤪

그 사실을 알고 나서는 여태 작성했던 모든 커밋의 메시지를 전부 갈아 엎어버리고 싶었다.

수치심은 뒤로 하고, 기록해보기로 한다.

커밋 메시지 7원칙

  • 제목과 본문을 빈 행으로 구분.
  • 제목 50자 이내로 제한.
  • 제목의 첫 글자는 대문자로 작성.
  • 제목의 끝에는 마침표 넣지 않기.
  • 제목은 명령문으로, 과거형 사용하지 않기.
  • 본문의 각 행은 72자 내로 제한.
  • 무엇과 왜를 설명하기.

커밋 메시지 구조

<type> : <subject>		--헤더
<BLANK LINE>			--빈 행
<body>					--본문
<BLANK LINE>			--빈 행
<footer>				--풋터

type의 종류

feat : 새로운 기능 추가
docs : 문서 수정
fix : 버그 수정
refactor : 리팩토링
chore : 빌드 업무 수정, 패키지 매니저 수정
test : 테스트 코드 추가 및 리팩토링
style : 코드 포맷팅, 로직에는 변경이 없는 수정
design : css 수정

참고한 글

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속

profile
Way to go

0개의 댓글