폴더 재구성: - reference/ → standards/, architecture/, quickstart/로 분리 - principles/ → architecture/로 통합 - specs/security-policy.md → architecture/로 이동 새 구조: - standards/: 개발 표준 (어떻게 코드를 작성할 것인가) - architecture/: 아키텍처 & 설계 원칙 (왜 이렇게 설계하는가) - rules/: 비즈니스 규칙 (무엇이 유효한 데이터인가) - specs/: 기술 스펙 (무엇을 구현할 것인가) - guides/: 구현 가이드 (어떻게 구현할 것인가) - quickstart/: 빠른 시작 INDEX.md 개선: - 작업별 필수 문서 테이블 추가 - 폴더별 문서 목록 및 필수 확인 시점 명시 - 폴더 선택 기준 가이드 추가
20 lines
801 B
Markdown
20 lines
801 B
Markdown
# Standards (개발 표준)
|
|
|
|
> 코드 작성 방법에 대한 규칙 - **"어떻게 코드를 작성할 것인가"**
|
|
|
|
## 목적
|
|
- 일관된 코드 스타일 유지
|
|
- 팀 간 협업 효율성 향상
|
|
- 코드 리뷰 기준 명확화
|
|
|
|
## 문서 목록
|
|
|
|
| 문서 | 설명 | 필수 확인 시점 |
|
|
|------|------|--------------|
|
|
| [api-rules.md](api-rules.md) | API 개발 규칙 (Service-First, FormRequest, i18n) | API 개발 전 |
|
|
| [git-conventions.md](git-conventions.md) | Git 커밋 메시지, 브랜치 전략 | 커밋 전 |
|
|
| [quality-checklist.md](quality-checklist.md) | 코드 품질 체크리스트 | PR 전 |
|
|
|
|
## 관련 폴더
|
|
- [architecture/](../architecture/) - 설계 원칙 (왜 이렇게 설계하는가)
|
|
- [rules/](../rules/) - 비즈니스 규칙 (무엇이 유효한 데이터인가) |