Branch Keyword
readme-mvp-docs
작업 내용
현재 MVP 범위, API 명세, 테스트 계획, 주문 처리 흐름은 .docs 하위 문서에 정리되어 있다.
다만 저장소 루트에 README.md가 없어, 포트폴리오나 외부 리뷰 관점에서 프로젝트의 목적과 구현 범위를 빠르게 파악하기 어렵다.
README.md를 추가해 CoinFlow MVP의 랜딩 페이지 역할을 하도록 한다.
- CoinFlow 한 줄 소개 추가
- MVP 구현 범위 요약
- MVP 제외 범위 명시
- 실행 방법 정리
- 테스트 방법 정리
- 주요 문서 링크 추가
.docs/PRD.md.docs/API.md.docs/ERD.md.docs/TestPlan.md.docs/ORDER_FLOW.md.docs/ISSUES.md
- Kafka/WebSocket/OutboxPublisher는 아직 미구현 다음 단계임을 명시
완료 기준
- 루트
README.md만 봐도 프로젝트 목적, 현재 구현 범위, 실행/테스트 방법을 이해할 수 있다.
- README에서 상세 문서로 자연스럽게 이동할 수 있다.
- 구현 완료 기능과 다음 단계 기능이 과장 없이 구분되어 있다.
Branch Keyword
readme-mvp-docs
작업 내용
현재 MVP 범위, API 명세, 테스트 계획, 주문 처리 흐름은
.docs하위 문서에 정리되어 있다.다만 저장소 루트에
README.md가 없어, 포트폴리오나 외부 리뷰 관점에서 프로젝트의 목적과 구현 범위를 빠르게 파악하기 어렵다.README.md를 추가해 CoinFlow MVP의 랜딩 페이지 역할을 하도록 한다..docs/PRD.md.docs/API.md.docs/ERD.md.docs/TestPlan.md.docs/ORDER_FLOW.md.docs/ISSUES.md완료 기준
README.md만 봐도 프로젝트 목적, 현재 구현 범위, 실행/테스트 방법을 이해할 수 있다.