<aside> ✅

Commit 컨벤션

커밋 메시지는 다음과 같이 message header, message body, message footer 형태를 갖는다.

<type>(<scope>): <short summary>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

예시

fix(type): user interface 타입 수정

- 유저 타입이 맞지 않아 age를 number 타입으로 변경하였습니다.

closes #351

message header(필수)

요약

Untitled

type

타입 용도 주석
feat 새로운 기능 추가
fix 버그 수정, 타입 수정
refactor 리팩토링 변수명 수정, 파일 이동, 폴더명 수정여기에 해당
style 코드 포맷팅(e.g. 세미콜론 누락 채움) prettier, linting
design css 등 사용자 UI 디자인 변경
perf 코드 변경으로 성능 개선을 이끌어 냈을 때
test 테스트(테스트 코드 추가, 수정, 삭제)
build 빌드 시스템 또는 외부 종속성에 영향을 미치는 변경 사항(예: gulp, 브로콜리, npm)
ci CI 구성 파일 및 스크립트 변경
docs 문서 관련 작업
comment 필요한 주석 추가, 변경, 삭제
chore 위 해당 사항에 해당하지 않는 기타 작업 e.g. 임시 생성 파일 삭제, 필요없는 파일 삭제

scope (optional)

예시

build(deps): bump React version to "17.0.2"

fix(type): 사용자 인터페이스의 나이 타입을 number로 변경

subject (=summary)

message body(옵셔널)

- 변경 내용 1
- 변경 내용 2
- 변경 내용 3

message footer(옵셔널)

예시

BREAKING CHANGE: <주요 변경 내역 요약>
<BLANK LINE>
<변경점 + 마이그레이션 지시>
<BLANK LINE>
<BLANK LINE>
Fixes #<이슈번호>

주요 변경 내역들 (Breaking Changes)

모든 주요 변경 내역들은 다음과 함께 하단에 언급되어야 한다.(생략 가능하게?)

해결된 이슈 (Referencing Issues)

커밋 메시지 제일 하단에 Keyword #<이슈번호>와 같이 기록되어야 한다.

Closes #234

Closes #123, #245, #992

Resolve #234

참고

  1. https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format
  2. https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w
  3. https://velog.io/@outstandingboy/Git-커밋-메시지-규약-정리-the-AngularJS-commit-conventions

</aside>