hskwon
08a8259313
- 5130 레거시 시스템 분석 (00_OVERVIEW ~ 08_SAM_COMPARISON) - MES 프로젝트 문서 - API/프론트엔드 스펙 문서 - 가이드 및 레퍼런스 문서
138 lines
2.9 KiB
Markdown
138 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 ../admin && 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 |