53 lines
2.8 KiB
Markdown
53 lines
2.8 KiB
Markdown
# Repository Guidelines
|
|
|
|
## 프로젝트 구조 및 모듈 구성
|
|
|
|
- `specification.md`는 컴포넌트 사양, 데이터 모델, TypeScript 스타일 인터페이스의 기준 문서입니다.
|
|
- `components/phase1/`, `components/phase2/`, `components/phase3/`에 단계별 컴포넌트 문서가 있습니다.
|
|
- Phase 1: `balance.md`, `mgmt.md`, `strategy.md`, `scheduler.md`, `data.md`, `risk.md`
|
|
- Phase 2: `analytics.md`, `monitor.md`
|
|
- Phase 3: `audit.md`, `simulation.md`
|
|
- `docs/`는 개요와 아키텍처 문서가 모여 있습니다(`01-overview.md`~`05-roadmap.md`).
|
|
- `diagram.md`에는 아키텍처 및 워크플로우를 설명하는 Mermaid 다이어그램이 있습니다.
|
|
|
|
이 저장소는 구현 코드가 없는 문서 중심 리포지토리입니다.
|
|
|
|
## 빌드, 테스트, 개발 명령
|
|
|
|
- 정의된 빌드/테스트 명령은 없습니다.
|
|
- 문서 변경 후 Markdown 미리보기나 Mermaid 뷰어로 확인하세요(예: `diagram.md`).
|
|
|
|
## 코딩 스타일 및 네이밍 규칙
|
|
|
|
- 문서 본문은 한국어를 기본으로 하며, 컴포넌트명과 인터페이스 식별자는 영어를 사용합니다.
|
|
- `specification.md`의 섹션 구조(책임, 주요 기능, 데이터 모델)를 유지하세요.
|
|
- 리스트, 코드 블록, Mermaid 블록은 Markdown 규칙을 따릅니다.
|
|
- 인터페이스 변경 시 관련 컴포넌트 문서의 타입 정의도 함께 업데이트합니다.
|
|
|
|
## 테스트 가이드
|
|
|
|
- 자동화된 테스트 프레임워크는 없습니다.
|
|
- 데이터 모델이나 워크플로우 변경 시 `specification.md`와 관련 컴포넌트 문서의 일관성을 함께 점검하세요.
|
|
|
|
## 커밋 및 PR 가이드
|
|
|
|
- Git 이력이 거의 없어 확정된 커밋 규칙은 없습니다.
|
|
- 커밋 메시지는 변경 내용을 구체적으로 작성하세요(예: "리스크 모델 필드 업데이트").
|
|
- PR에는 요약, 영향받는 파일, 다이어그램/워크플로우 변경 여부를 포함하세요.
|
|
|
|
## 아키텍처 및 워크플로우 정합성
|
|
|
|
- 실행 플로우(스케줄러 → 전략 → 리스크 → 주문)를 바꾸면 `docs/04-workflows.md`와 `diagram.md`를 함께 수정합니다.
|
|
- 컨테이너 기반 자산 격리, 리스크 우선 설계 등 핵심 원칙은 유지합니다.
|
|
- 다이어그램을 수정했다면 텍스트 설명도 동기화하세요.
|
|
|
|
## 문서 변경 체크리스트
|
|
|
|
- 데이터 모델 변경 시 `specification.md`와 관련 컴포넌트 문서를 모두 갱신합니다.
|
|
- Phase별 영향 범위를 확인하고 연동 문서를 함께 수정합니다.
|
|
- 외부 연동(브로커/데이터 소스) 가정이 바뀌면 `docs/02-architecture.md`도 점검합니다.
|
|
|
|
## 작업 전 확인
|
|
|
|
- `CLAUDE.md`에 있는 저장소 특성(문서 전용, 한국어 중심, 리스크 우선 설계)과 수정 가이드를 먼저 확인합니다.
|