Minkeun Park

commit message 규칙(형식) 정의

형식

<task>(<type>): <subject>
<blank line>
<body>
<blank line>
<footer>

<task>

완료한 작업의 종류를 표현

  • feat - 새로운 기능 추가 (되도록이면 unit test도 같이 추가)
  • fix - 버그 수정
  • docs - document 관련 작업
  • style - formatting(띄워쓰기, 들여쓰기), 오타 수정
  • refactor - 코드 수정(중복 제거, 변수, 함수 이름, data type 변경 등)
  • test - 새로운 테스트 추가
  • chore - 빌드, dependency 관리, .gitignore 편집
  • config - 설정 파일 수정

<type>

수정한 내용을 포함하는 도메인, 기능 이름

<subject>

  • 현재시제 사용
  • 문장 첫 글자는 대문자로 적지 않는다
  • 문장의 마지막에 마침표를 사용하지 않는다

<body>

  • optional(생략 가능)
  • 문장 첫 글자 대문자 사용
  • 현재시제 사용
  • 변경 내용에 대한 설명(이유와 변경 결과 달라진 점)
  • optional(생략 가능)

  • issue number - 해당 change로 해결한 issue 번호(여러 개도 가능)

      Closes #123 #456 #789

references

Comments

You May Also Enjoy