본문으로 건너뛰기

커밋 룰


Commit Message 를 작성할때 일반적으로 통용되는 룰에 대해서 알아보자

개요

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

body(본문, 생략 가능)

Resolves : #issue, ...(해결한 이슈 , 생략 가능)

See also : #issue, ...(참고 이슈, 생략 가능)

커밋의 유형

  • FEAT : 새로운 기능의 추가
  • FIX: 버그 수정
  • DOCS: 문서 수정
  • STYLE: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
  • REFACTOR: 코드 리펙토링
  • TEST: 테스트 코트, 리펙토링 테스트 코드 추가
  • CHORE: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)

예시

Feat: 관심지역 알림 ON/OFF 기능 추가(#123)

시군구의 알림을 각각 ON/OFF 할 수 있도록 기능을 추가함
- opnion0055: 구분 코드

해결: close #123