[Git] Commit Message 작성하기

FreshBreeze·2024년 10월 16일
0

https://gist.github.com/stephenparish/9941e89d80e2bc58a153
https://github.com/angular/angular/blob/main/CONTRIBUTING.md#type

Format of the commit message

<type>(<scope>): <subject> // Subject line

<body> // Message body

<footer> // Message footer

1. Subject line - 변경점 간결한 설명

<type>

  • build: 빌드 시스템이나 외부 종속성에 영향을 미치는 변경
  • ci: CI 구성 파일 및 스크립트에 대한 변경
  • docs: 문서 관련 변경만 포함
  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • perf: 성능을 개선하는 코드 변경
  • refactor: 버그 수정이나 기능 추가가 아닌 코드 변경
  • test: 누락된 테스트 추가 또는 기존 테스트 수정

<scope>

  • 커밋 변경사항이 적용된 위치, 생략가능

<subject>

  • 짧고 명확한 명령형으로 끝맺기 ( "변경한다" -> "변경" )
  • 끝에 마침표를 넣지 않음

2. Message body

  • <subject>와 마찬가지로 명령형, 마침표 X.
  • 변경의 이유이전 동작과의 차이점 포함.
  • Breaking changes : 변경 내용, 이유, 마이그레이션 방법 작성
  • Referencing issues : 해결된 이슈는 하단에 "Closes" 키워드를 앞에 붙이기
    Closes #123, #245, #992

0개의 댓글

관련 채용 정보