좋은 Git Commit Message을 작성하기 위해 필요한 규칙과 방법들

Salt·2024년 5월 21일
post-thumbnail

🟢 Commit message 규칙

  1. 제목과 본문을 빈 행으로 분리한다.
  2. 제목은 50자로 제한한다.
  3. 제목의 첫 글자는 대문자로 쓴다.
  4. 제목 끝에는 마침표를 넣지 않는다.
  5. 제목에는 명령문을 사용한다.
  6. 본문을 72자 단위로 개행한다.
  7. 어떻게 보다는 무엇과 왜를 설명한다.

🟢 Commit message 구조

// Header, Body, Footer는 빈 행으로 구분
타입(스코프): 주제(제목) // *Header

본문 // Body

바닥글 // Footer

Header필수이며 스코프는 생략이 가능하다.
타입은 해당 커밋의 성격을 나타내며 아래 중 하나여야 한다.

타입 키워드사용 시점
feat새로운 기능 추가
fix버그 수정
docs문서 수정
style코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등..)
designUI 변경 (CSS)
test테스트 코드 추가
refactor코드 리팩토링
build빌드 파일 수정
ciCI 설정 파일 수정
perf성능 개선
chore빌드 업무 수정, 패키지 매니저 수정 (.gitignore..)
rename파일, 폴더명 수정
remove파일 삭제

Body에는 Header에 표현할 수 없는 상세한 내용을 적는다. (Header에서 충분히 설명 가능하면 생략)
Footer는 어떤 이슈에서 왔는지 참조 정보들을 추가하는 용도로 사용한다. ex) Issues#1000

🟢 Commit message 관련 이슈

관련 이슈 언급은 선택사항. 보통 팀에서 지정한 키워드를 사용한다.

사용 시점사용 키워드
해결Closes(종료), Fixes(수정), Resolves(해결)
참고Ref(참고), Related to(관련), See also(참고)

0개의 댓글