docs: [claude] Git 커밋 규칙을 sam/docs 협약 기준으로 통일
- 커밋 형식: type:메시지 → type: [scope] 작업내용 - Co-Authored-By 서명 제외 정책 반영 - style, test 타입 추가 - 푸시 정책 (자동 푸시 금지) 추가 - 커밋 전 체크리스트 보강
This commit is contained in:
75
CLAUDE.md
75
CLAUDE.md
@@ -25,6 +25,7 @@ SAM 프로젝트의 기술적 개요 문서입니다. 이 문서를 참조하면
|
||||
## Git 커밋 규칙 (최우선 필수 규칙)
|
||||
|
||||
> **경고: 이 규칙은 절대 누락되어서는 안 됩니다!**
|
||||
> **기준 문서**: `sam/docs/standards/git-conventions.md`
|
||||
|
||||
### 필수 수행 절차
|
||||
|
||||
@@ -33,17 +34,58 @@ SAM 프로젝트의 기술적 개요 문서입니다. 이 문서를 참조하면
|
||||
1. 변경된 파일이 있는 Git 저장소로 이동
|
||||
2. `git status`로 변경사항 확인
|
||||
3. `git add <파일들>` 로 스테이징
|
||||
4. `git commit -m "type:메시지"` 로 커밋
|
||||
4. `git commit -m "type: [scope] 작업내용"` 로 커밋
|
||||
|
||||
### 커밋 메시지 형식 (필수)
|
||||
|
||||
| Prefix | 사용 시점 | 예시 |
|
||||
|--------|----------|------|
|
||||
| `feat:` | 새로운 파일/기능 생성 | `feat:새 기능 추가` |
|
||||
| `fix:` | 버그 수정, 코드 수정 | `fix:오류 수정` |
|
||||
| `refactor:` | 코드 리팩토링 | `refactor:구조 개선` |
|
||||
| `docs:` | 문서 수정 | `docs:README 업데이트` |
|
||||
| `chore:` | 설정, 빌드 관련 | `chore:설정 변경` |
|
||||
```
|
||||
type: [scope] 작업내용
|
||||
|
||||
- 세부항목 (생략가능)
|
||||
- 세부항목 2
|
||||
|
||||
Issue: URL (생략가능)
|
||||
```
|
||||
|
||||
**예시:**
|
||||
```bash
|
||||
feat: [calendar] 달력 기능 개선
|
||||
|
||||
- 클릭시 오류 기능 개선
|
||||
- 색상 변경
|
||||
```
|
||||
|
||||
```bash
|
||||
fix: [auth] 로그인 시 세션 만료 오류 수정
|
||||
```
|
||||
|
||||
### Commit Types
|
||||
|
||||
| Type | 설명 | 예시 |
|
||||
|------|------|------|
|
||||
| `feat` | 새로운 기능 추가 | `feat: [file] 파일 업로드 기능 추가` |
|
||||
| `fix` | 버그 수정 | `fix: [auth] 세션 만료 오류 수정` |
|
||||
| `chore` | 설정, 빌드 등 변경 | `chore: composer 패키지 업데이트` |
|
||||
| `refactor` | 프로덕션 코드 리팩토링 | `refactor: [user] 서비스 메서드 분리` |
|
||||
| `style` | 포맷/코딩 스타일 수정 | `style: Pint 포맷팅 적용` |
|
||||
| `test` | 테스트 추가/수정 | `test: Product API 테스트 추가` |
|
||||
| `docs` | 문서 변경 | `docs: API 문서 업데이트` |
|
||||
|
||||
### Claude 서명 제외 (필수)
|
||||
|
||||
```
|
||||
❌ Co-Authored-By: Claude <noreply@anthropic.com> — 포함 금지
|
||||
❌ 🤖 Generated with Claude Code — 포함 금지
|
||||
```
|
||||
|
||||
- Git hooks로 자동 제거됨
|
||||
- 간결하고 명확한 한글 커밋 메시지만 유지
|
||||
|
||||
### 푸시 정책
|
||||
|
||||
- **사용자가 수동으로 푸시 진행**
|
||||
- 자동 푸시 하지 않음
|
||||
- 커밋 후 푸시 여부를 묻지 않음
|
||||
|
||||
### Claude Code 설정 파일도 커밋 대상
|
||||
|
||||
@@ -51,17 +93,20 @@ SAM 프로젝트의 기술적 개요 문서입니다. 이 문서를 참조하면
|
||||
|
||||
| 파일/폴더 | 설명 | 커밋 예시 |
|
||||
|-----------|------|----------|
|
||||
| `CLAUDE.md` | 프로젝트 설정 | `docs:CLAUDE.md 규칙 업데이트` |
|
||||
| `claudedocs/` | Claude 관련 문서 | `docs:기능 분석 문서 추가` |
|
||||
| `.claude/settings.json` | Claude 설정 | `chore:Claude 설정 변경` |
|
||||
| `agents/`, `skills/` | 커스텀 에이전트/스킬 | `feat:새 스킬 추가` |
|
||||
| `CLAUDE.md` | 프로젝트 설정 | `docs: CLAUDE.md 규칙 업데이트` |
|
||||
| `claudedocs/` | Claude 관련 문서 | `docs: 기능 분석 문서 추가` |
|
||||
| `.claude/settings.json` | Claude 설정 | `chore: Claude 설정 변경` |
|
||||
| `agents/`, `skills/` | 커스텀 에이전트/스킬 | `feat: [claude] 새 스킬 추가` |
|
||||
|
||||
### 체크리스트 (작업 완료 시 확인)
|
||||
### 커밋 전 체크리스트
|
||||
|
||||
- [ ] `./vendor/bin/pint` 실행 (코드 포맷팅, 해당 시)
|
||||
- [ ] `git diff`로 변경사항 검토
|
||||
- [ ] 불필요한 파일 제외 (.env, node_modules 등)
|
||||
- [ ] 변경된 파일이 있는 저장소에서 git add → git commit
|
||||
- [ ] CLAUDE.md, claudedocs/, agents/, skills/ 변경 확인 → git commit
|
||||
- [ ] 커밋 메시지에 적절한 prefix 사용 (feat:/fix:/refactor:/docs:/chore:)
|
||||
- [ ] 한글로 명확한 커밋 메시지 작성
|
||||
- [ ] 커밋 메시지: `type: [scope] 한글 작업내용` 형식 준수
|
||||
- [ ] Co-Authored-By 서명 미포함 확인
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user