저장소

카테고리 문서

태그

#git #commit #convention #guide

1. 기본 작성 원칙

커밋 메시지는 제목만 짧게 남기지 않고, 변경 배경과 수정 내용, 검증 결과를 함께 남긴다.

제목은 type(scope): 작업 요약 형식으로 작성한다.
본문에는 왜 수정했는지 먼저 적는다.
변경한 영역은 추가/수정: 아래에 정리한다.
검증 결과는 결과: 아래에 명령어와 결과를 함께 적는다.

2. 커밋 제목 규칙

커밋 제목은 변경 종류와 범위를 먼저 보여주는 형식으로 작성한다.

type(scope): 작업 요약

type 예시

fix: 오류 수정
docs: 문서 추가 또는 수정
style: 화면 스타일 또는 포맷 수정
refactor: 동작을 유지한 코드 구조 개선
test: 테스트 추가 또는 수정
chore: 빌드, 설정, 자동 생성 파일 등 보조 작업

scope 예시

posts: 포스트 내용 또는 형식
theme: 라이트/다크 테마
pagination: 연도 또는 카테고리 페이징
readme: README 인덱스
scripts: 자동화 스크립트

3. 본문 작성 규칙

본문은 작업 배경, 추가/수정 내용, 결과 순서로 작성한다.

작업 배경과 원인 설명

추가/수정:
- 영역
  - 변경 내용
  - 변경 내용

결과:
- 사용자 또는 기능 관점의 결과
- 검증: 명령어 -> 결과
- 검증: 명령어 -> 결과

4. 변경 내용 작성 규칙

추가/수정: 아래에는 파일명만 나열하지 않고, 영역별로 어떤 동작이 바뀌었는지 적는다.

추가/수정:
- posts
  - docs 카테고리에 커밋 메시지 작성 가이드 추가
- readme
  - 문서 카테고리 글 수와 링크 갱신

변경 영역이 여러 개라면 기능 기준으로 나누고, 한 영역 안에는 관련 변경만 묶는다.

5. 검증 결과 작성 규칙

결과: 아래에는 작업 결과와 검증 명령을 함께 남긴다.

결과:
- 커밋 메시지 작성 기준을 문서 카테고리에서 확인할 수 있게 됐다.
- 검증: python scripts/check_post_format.py -> 통과
- 검증: python scripts/generate_pages.py -> 통과
- 검증: git diff --check -> 통과

검증하지 못한 항목은 성공한 것처럼 쓰지 않고, 실행하지 못한 이유를 적는다.

6. 작성 예시

docs(posts): 커밋 메시지 작성 가이드 추가

커밋할 때 변경 배경, 수정 범위, 검증 결과를 같은 형식으로
남길 수 있도록 문서 카테고리에 작성 기준을 추가했다.

추가/수정:
- posts
  - docs 카테고리에 커밋 메시지 작성 가이드 추가
- readme
  - 문서 카테고리 글 수와 링크 갱신

결과:
- 커밋 메시지 작성 기준을 사이트에서 확인할 수 있게 됐다.
- 검증: python scripts/check_post_format.py -> 통과
- 검증: python scripts/generate_pages.py -> 통과
- 검증: git diff --check -> 통과

핵심 정리

커밋 제목은 type(scope): 작업 요약 형식으로 작성한다.

본문은 작업 배경, 추가/수정, 결과 순서로 작성한다.

검증 결과는 실제로 실행한 명령어와 결과만 적는다.