docs: 규칙 및 원칙 문서 체계 추가
- standards/ 폴더 추가 (코딩 규칙: 네이밍, 스타일) - rules/ 폴더 추가 (비즈니스 규칙: 검증, 도메인 로직) - principles/ 폴더 추가 (설계 원칙: 아키텍처, API 설계) - INDEX.md에 규칙 및 원칙 섹션 추가 - 각 폴더에 README.md 생성
This commit is contained in:
23
standards/README.md
Normal file
23
standards/README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Standards (코딩 규칙)
|
||||
|
||||
> 개발 시 준수해야 할 코딩 컨벤션과 스타일 가이드
|
||||
|
||||
## 목적
|
||||
- 일관된 코드 스타일 유지
|
||||
- 팀 간 협업 효율성 향상
|
||||
- 코드 리뷰 기준 명확화
|
||||
|
||||
## 포함 내용
|
||||
- 네이밍 컨벤션 (변수, 함수, 클래스, 파일)
|
||||
- 코드 스타일 (들여쓰기, 주석, 포맷팅)
|
||||
- 디렉토리 구조 규칙
|
||||
- 테스트 작성 규칙
|
||||
|
||||
## 문서 목록
|
||||
| 문서 | 설명 |
|
||||
|------|------|
|
||||
| *(작성 예정)* | |
|
||||
|
||||
## 관련 문서
|
||||
- [API 개발 규칙](../reference/api-rules.md) - API 개발 표준
|
||||
- [Git 규칙](../reference/git-conventions.md) - 커밋 메시지, 브랜치 전략
|
||||
Reference in New Issue
Block a user