git commit 메세지 작성법

유정·2023년 6월 30일
post-thumbnail

ref: https://www.conventionalcommits.org/ko/v1.0.0/

커밋 메세지 구조

<타입>[적용 범위(선택 사항)]: <설명>

[본문(선택 사항)]

[꼬리말(선택 사항)]
  • commit 의 제목은 commit 을 설명하는 하나의 구나 절로 완성

접두어(prefix)

  • feat: 기능 개발 관련
  • fix: 오류 개선 혹은 버그 패치
  • docs: 문서화 작업
  • style: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
  • test: test 관련
  • refactor: 코드 리펙토링
  • conf: 환경설정 관련
  • build: 빌드 관련
  • ci: Continuous Integration 관련
  • chore: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)

예시

feat: Add server.py
fix: Fix Typo server.py
docs: Add README.md, LICENSE
conf: Create .env, .gitignore, dockerfile
BREAKING CHANGE: Drop Support /api/v1
refactor: Refactor user classes

Commit Convention은 팀마다 다를 수 있으니 관련 문서를 참조할 것.

profile
오늘은 모르더라도 내일은 아는 사람

0개의 댓글