[Git] Commit Message Style Guide

G·2024년 9월 2일
0

커밋 메시지를 작성할 때는 원칙을 정하고 일관성 있게 작성해야 합니다.

제가 사용하고 있는 커밋 메시지 스타일을 공유합니다.

1. Structure

커밋 메시지는 제목/본문으로 구성합니다. 제목에는 타입, 스코프가 포함됩니다.

[type][scope] subject
..줄바꿈
body

예시

[feat][ui] 메인 화면

- 상단 메뉴
- 하단 메뉴
[fix][auth] 로그인 흐름에서 토큰 만료 처리 수정
[fix][ui] 대시보드에서 텍스트 겹침 문제 해결
[wip][profile] 사용자 프로필 화면 기본 구조 구현중
[chore] 새로운 배포 프로세스에 맞게 빌드 스크립트 수정

2. Type

  • feat: 기능 추가/수정
  • fix: 버그 수정
  • wip: 진행중인 작업 (Work In Progress)
  • delete: 삭제
  • refactor: 코드 리팩토링
  • test: 테스트 추가/수정
  • style: 코드 포맷팅 (코드 변경 없음)
  • chore: 빌드 설정 수정, 패키지 매니저 수정 등
  • docs: 문서 추가/수정

3. Scope

Scope는 변경 사항이 적용된 코드베이스의 특정 영역이나 모듈을 나타냅니다. 이를 통해 커밋이 어떤 부분에 영향을 미치는지 명확히 알 수 있습니다. 다음은 scope를 정의하는 몇 가지 팁입니다.

  • 모듈/컴포넌트 이름: ui, auth, dashboard, api, database 등
  • 기능 영역: login, registration 등
  • 페이지 또는 화면 이름: main, home, settings, profile 등
profile
Hello!

0개의 댓글

관련 채용 정보