Files
sam-docs/standards/git-conventions.md
hskwon 88644c88ab docs: 문서 폴더 구조 대폭 재정리
폴더 재구성:
- reference/ → standards/, architecture/, quickstart/로 분리
- principles/ → architecture/로 통합
- specs/security-policy.md → architecture/로 이동

새 구조:
- standards/: 개발 표준 (어떻게 코드를 작성할 것인가)
- architecture/: 아키텍처 & 설계 원칙 (왜 이렇게 설계하는가)
- rules/: 비즈니스 규칙 (무엇이 유효한 데이터인가)
- specs/: 기술 스펙 (무엇을 구현할 것인가)
- guides/: 구현 가이드 (어떻게 구현할 것인가)
- quickstart/: 빠른 시작

INDEX.md 개선:
- 작업별 필수 문서 테이블 추가
- 폴더별 문서 목록 및 필수 확인 시점 명시
- 폴더 선택 기준 가이드 추가
2025-12-05 21:43:29 +09:00

2.9 KiB

Git 커밋 컨벤션

업데이트: 2025-12-02


커밋 메시지 형식

[타입]: [scope] 작업내용

- 세부항목 (생략가능)
- 세부항목 2

Issue: URL (생략가능)

예시

feat: [calendar] 달력 기능 개선

- 클릭시 오류 기능 개선
- 색상 변경
- 각 항목별 색상 지정

Issue: https://www.notion.so/hamss/2269c8d34ba080489680e0607a95d9c4
fix: [auth] 로그인 시 세션 만료 오류 수정
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로 자동 제거됨
  • 간결하고 명확한 한글 커밋 메시지만 유지

저장소별 커밋

# 각 저장소에서 개별 커밋
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

# main/master에서 직접 작업 금지
git checkout -b feature/file-storage-system
# 작업 진행...
git commit -m "feat: [file] ..."
# PR 생성

Hotfix

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 업데이트

푸시 정책

  • 사용자가 수동으로 푸시 진행
  • 자동 푸시 하지 않음
  • 커밋 후 푸시 여부를 묻지 않음

중요 사항

  • 각 저장소는 독립적으로 운영
  • 저장소별 개별 커밋 메시지 사용
  • 일관된 커밋 타입 및 형식 유지

관련 문서


최종 업데이트: 2025-12-02