Files
sam-docs/standards/git-conventions.md
kent 66eac6b39f docs: [문서정리] 전체 문서 업데이트 및 admin→mng 전환 반영
- Phase 1-3: 핵심/보조 문서 업데이트, 버전 최신화
- Phase 4: 오래된 파일 정리 및 아카이브
  - D0.8 Storyboard → history/2025-12/ 이동
  - admin 참조 4개 파일 수정 (docker-setup, git-conventions, project-launch-roadmap, remote-work-setup)
  - 빈 디렉토리 6개 삭제
- 버전 정보: React 19.2.1, Next.js 15.5.7
- remote-work-setup.md DEPRECATED 표시
2025-12-26 16:47:36 +09:00

137 lines
2.9 KiB
Markdown

# Git 커밋 컨벤션
**업데이트**: 2025-12-02
---
## 커밋 메시지 형식
```
[타입]: [scope] 작업내용
- 세부항목 (생략가능)
- 세부항목 2
Issue: URL (생략가능)
```
### 예시
```bash
feat: [calendar] 달력 기능 개선
- 클릭시 오류 기능 개선
- 색상 변경
- 각 항목별 색상 지정
Issue: https://www.notion.so/hamss/2269c8d34ba080489680e0607a95d9c4
```
```bash
fix: [auth] 로그인 시 세션 만료 오류 수정
```
```bash
refactor: [user] UserService 메서드 분리
- validateUser 메서드 추출
- 중복 코드 제거
```
---
## 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 서명 제외 정책
**커밋 메시지에 다음 내용을 포함하지 않음:**
```
❌ 🤖 Generated with [Claude Code](https://claude.com/claude-code)
❌ Co-Authored-By: Claude <noreply@anthropic.com>
```
- Git hooks로 자동 제거됨
- 간결하고 명확한 한글 커밋 메시지만 유지
---
## 저장소별 커밋
```bash
# 각 저장소에서 개별 커밋
cd api && git add . && git commit -m "feat: [scope] 작업 내용"
cd ../mng && git add . && git commit -m "feat: [scope] 작업 내용"
cd ../react && git add . && git commit -m "feat: [scope] 작업 내용"
```
---
## Branch 전략
### Feature Development
```bash
# main/master에서 직접 작업 금지
git checkout -b feature/file-storage-system
# 작업 진행...
git commit -m "feat: [file] ..."
# PR 생성
```
### Hotfix
```bash
git checkout -b hotfix/login-session-bug
# 긴급 수정...
git commit -m "fix: [auth] ..."
# PR 또는 즉시 병합
```
---
## 커밋 전 체크리스트
```
✓ ./vendor/bin/pint 실행 (코드 포맷팅)
✓ php artisan migrate:status 확인
✓ 테스트 실행 (해당하는 경우)
✓ git diff 로 변경사항 검토
✓ 불필요한 파일 제외 (.env, node_modules 등)
✓ CURRENT_WORKS.md 업데이트
```
---
## 푸시 정책
- **사용자가 수동으로 푸시 진행**
- 자동 푸시 하지 않음
- 커밋 후 푸시 여부를 묻지 않음
---
## 중요 사항
- **각 저장소는 독립적으로 운영**
- 저장소별 개별 커밋 메시지 사용
- 일관된 커밋 타입 및 형식 유지
## 관련 문서
- [개발 명령어](./dev-commands.md)
- [품질 체크리스트](./quality-checklist.md)
---
**최종 업데이트**: 2025-12-02