더 나은 커밋 남기기

May 29, 2024
더 나은 커밋 남기기

Commit Message 7가지 규칙

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

커밋 메시지 구조

type: Subject body footer
 

타입

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
  • refactor : 코드 리팩터링
  • test : 테스트 코드, 리팩터링 테스트 코드 추가(프로덕션 코드 변경 X)
  • chore : 빌드 업무 수정, 패키지 매니저 수정(프로덕션 코드 변경 X)
  • design : CSS 등 사용자 UI 디자인 변경
  • comment : 필요한 주석 추가 및 변경
  • rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
  • remove : 파일을 삭제하는 작업만 수행한 경우
  • !BREAKING CHANGE : 커다란 API 변경의 경우
  • !HOTFIX : 급하게 치명적인 버그를 고쳐야 하는 경우
notion image
 
 
 
Share article

정리한 노션 내용을 올리는 공간