docs(readme): README 축약 및 문서 분리#45
Conversation
Summary of ChangesHello @tnemnorivnelee, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! 이 풀 리퀘스트는 프로젝트 문서의 가독성과 유지보수성을 향상시키기 위해 기존 README.md의 내용을 재구성하고 전문화된 문서 파일로 분리하는 작업을 수행합니다. 이를 통해 사용자와 개발자는 특정 정보에 더 빠르게 접근하고, 문서 구조를 명확하게 이해할 수 있게 됩니다. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
| ```bash | ||
| # 프로젝트 폴더로 이동 | ||
| cd hansei-ro | ||
|
|
||
| # 필요한 패키지 설치 | ||
| yarn install | ||
| ``` | ||
|
|
||
| ### 2단계: 환경 변수 설정 | ||
|
|
||
| 프로젝트 루트에 `.env.local` 파일을 생성하고 다음 내용을 입력하세요: | ||
|
|
||
| ```env | ||
| EXPO_PUBLIC_API_URL=http://localhost:3000 | ||
| ``` | ||
|
|
||
| > 💡 **팁**: 백엔드 서버 주소를 팀원에게 확인하세요! | ||
|
|
||
| ### 3단계: 개발 서버 실행 | ||
|
|
||
| ```bash | ||
| # Expo 개발 서버 실행 | ||
| yarn start | ||
| ``` |
There was a problem hiding this comment.
'빠른 시작' 섹션이 매우 간결해진 점은 좋지만, .env.local 파일 생성에 대한 설명이 없어 처음 프로젝트를 접하는 사람에게는 다소 불명확할 수 있습니다. 파일 생성에 대한 간단한 안내 문구를 추가하고, 각 명령어에 주석을 달아 가독성을 높이는 것을 제안합니다.
| ```bash | |
| # 프로젝트 폴더로 이동 | |
| cd hansei-ro | |
| # 필요한 패키지 설치 | |
| yarn install | |
| ``` | |
| ### 2단계: 환경 변수 설정 | |
| 프로젝트 루트에 `.env.local` 파일을 생성하고 다음 내용을 입력하세요: | |
| ```env | |
| EXPO_PUBLIC_API_URL=http://localhost:3000 | |
| ``` | |
| > 💡 **팁**: 백엔드 서버 주소를 팀원에게 확인하세요! | |
| ### 3단계: 개발 서버 실행 | |
| ```bash | |
| # Expo 개발 서버 실행 | |
| yarn start | |
| ``` | |
| # 1. 의존성 설치 | |
| yarn install |
프로젝트 루트에 .env.local 파일을 생성하고 아래 내용을 추가하세요.
EXPO_PUBLIC_API_URL=http://localhost:3000# 2. 개발 서버 실행
yarn start| | 상황 | 위치 | 예시 | | ||
| | ------------------------------------------ | --------------------- | -------------------------------------- | | ||
| | **1개 기능에서만 사용** | `features/[기능]/ui/` | `MatchCard.tsx` → `features/match/ui/` | | ||
| | **2~3곳에서 사용 (아직 확실하지 않음)** | 원래 위치에 유지 | 아직 `features/match/ui/`에 둠 | |
There was a problem hiding this comment.
표현의 일관성을 위해 구어체인 '둠' 대신 '유지'와 같은 서술적인 표현을 사용하는 것이 좋겠습니다.
| | **2~3곳에서 사용 (아직 확실하지 않음)** | 원래 위치에 유지 | 아직 `features/match/ui/`에 둠 | | |
| | **2~3곳에서 사용 (아직 확실하지 않음)** | 원래 위치에 유지 | `features/match/ui/`에 유지 | |
| ## 📎 참고 문서 | ||
|
|
||
| - `docs/GUIDE_FEATURE.md` : 새 기능 추가 가이드 | ||
| - `docs/CONVENTIONS.md` : 개발 컨벤션 |
There was a problem hiding this comment.
문서 간 탐색 편의성을 높이기 위해 '참고 문서' 섹션의 파일 경로를 클릭 가능한 마크다운 링크로 수정하는 것을 제안합니다. 또한, 문서 내 다른 파일 참조(54행의 GUIDE_FEATURE.md, 86행의 src/api/generated/README.md)도 링크로 만들면 사용자가 관련 정보를 더 쉽게 찾을 수 있습니다.
| ## 📎 참고 문서 | |
| - `docs/GUIDE_FEATURE.md` : 새 기능 추가 가이드 | |
| - `docs/CONVENTIONS.md` : 개발 컨벤션 | |
| ## 📎 참고 문서 | |
| - [`docs/GUIDE_FEATURE.md`](./GUIDE_FEATURE.md) : 새 기능 추가 가이드 | |
| - [`docs/CONVENTIONS.md`](./CONVENTIONS.md) : 개발 컨벤션 |
| ## 📎 참고 문서 | ||
|
|
||
| - `docs/ARCHITECTURE.md` : 프로젝트 구조/규칙 | ||
| - `docs/CONVENTIONS.md` : Git/브랜치/커밋/코드 스타일 | ||
| - `docs/SETUP.md` : 개발 환경 설정 |
There was a problem hiding this comment.
문서 간 탐색 흐름을 개선하기 위해 '참고 문서' 섹션의 파일 경로들을 클릭 가능한 마크다운 링크로 수정해주세요. 추가로 '다음 단계' 섹션(217-218행)의 경로들도 링크로 만들면 더욱 좋을 것 같습니다.
| ## 📎 참고 문서 | |
| - `docs/ARCHITECTURE.md` : 프로젝트 구조/규칙 | |
| - `docs/CONVENTIONS.md` : Git/브랜치/커밋/코드 스타일 | |
| - `docs/SETUP.md` : 개발 환경 설정 | |
| ## 📎 참고 문서 | |
| - [`docs/ARCHITECTURE.md`](./ARCHITECTURE.md) : 프로젝트 구조/규칙 | |
| - [`docs/CONVENTIONS.md`](./CONVENTIONS.md) : Git/브랜치/커밋/코드 스타일 | |
| - [`docs/SETUP.md`](./SETUP.md) : 개발 환경 설정 |
| ## 📎 참고 문서 | ||
|
|
||
| - `docs/TROUBLESHOOTING.md` : 환경 설정 문제 해결 | ||
| - `docs/CONVENTIONS.md` : Git/브랜치/커밋/코드 스타일 규칙 |
There was a problem hiding this comment.
문서 간 이동 편의성을 위해 '참고 문서' 섹션의 파일 경로들을 마크다운 링크로 수정하는 것을 제안합니다. 또한 96행의 TROUBLESHOOTING.md 참조 역시 링크로 만들면 사용자가 문제 해결 가이드로 더 쉽게 이동할 수 있을 것입니다.
| ## 📎 참고 문서 | |
| - `docs/TROUBLESHOOTING.md` : 환경 설정 문제 해결 | |
| - `docs/CONVENTIONS.md` : Git/브랜치/커밋/코드 스타일 규칙 | |
| ## 📎 참고 문서 | |
| - [`docs/TROUBLESHOOTING.md`](./TROUBLESHOOTING.md) : 환경 설정 문제 해결 | |
| - [`docs/CONVENTIONS.md`](./CONVENTIONS.md) : Git/브랜치/커밋/코드 스타일 규칙 |
| ## 📎 참고 문서 | ||
|
|
||
| - `docs/SETUP.md` : 개발 환경 설정 | ||
| - `docs/CONVENTIONS.md` : 개발 컨벤션 |
There was a problem hiding this comment.
문서 간 탐색 편의성을 높이기 위해 '참고 문서' 섹션의 파일 경로들을 클릭 가능한 마크다운 링크로 수정하는 것을 제안합니다.
| ## 📎 참고 문서 | |
| - `docs/SETUP.md` : 개발 환경 설정 | |
| - `docs/CONVENTIONS.md` : 개발 컨벤션 | |
| ## 📎 참고 문서 | |
| - [`docs/SETUP.md`](./SETUP.md) : 개발 환경 설정 | |
| - [`docs/CONVENTIONS.md`](./CONVENTIONS.md) : 개발 컨벤션 |
There was a problem hiding this comment.
Pull request overview
README를 축약하고 상세 문서를 역할별로 분리하여 문서 구조를 개선한 PR입니다. 핵심 시작 가이드는 README에 남기고, 세부 내용은 전용 문서로 이동했습니다.
Changes:
- README.md를 간결하게 축약하고 문서 링크 중심으로 재구성
- 개발 환경 설정 가이드를 docs/SETUP.md로 분리
- 프로젝트 구조 및 Orval 설명을 docs/ARCHITECTURE.md로 분리
- 기능 추가 가이드 및 FAQ를 docs/GUIDE_FEATURE.md로 분리
- 문제 해결 가이드를 docs/TROUBLESHOOTING.md로 분리
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | 핵심 시작 단계와 문서 링크만 남기고 대폭 축약 (771줄 → 33줄) |
| docs/SETUP.md | 개발 환경 설정, 테스트 빌드 설치, Java/Android/iOS 설정 가이드 (352줄 신규) |
| docs/ARCHITECTURE.md | 프로젝트 폴더 구조, 컴포넌트 배치 규칙, Orval 설명 (93줄 신규) |
| docs/GUIDE_FEATURE.md | 새 기능 추가 단계별 가이드 및 FAQ (226줄 신규) |
| docs/TROUBLESHOOTING.md | 자주 발생하는 문제와 해결 방법 정리 (73줄 신규) |
| - `docs/SETUP.md` : 개발 환경 설정 | ||
| - `docs/CONVENTIONS.md` : 개발 컨벤션 |
There was a problem hiding this comment.
문서 간 상호 링크가 일관되지 않습니다. 다른 문서에서는 "docs/CONVENTIONS.md"를 참조하지만, 이 문서에서는 "docs/CONVENTIONS.md"가 아닌 다른 문서들만 링크하고 있습니다. CONVENTIONS.md 링크를 추가하는 것을 고려해 주세요.
| - `docs/SETUP.md` : 개발 환경 설정 | |
| - `docs/CONVENTIONS.md` : 개발 컨벤션 | |
| - [개발 환경 설정](./SETUP.md) | |
| - [개발 컨벤션](./CONVENTIONS.md) |
| ## 📎 참고 문서 | ||
|
|
||
| - `docs/TROUBLESHOOTING.md` : 환경 설정 문제 해결 | ||
| - `docs/CONVENTIONS.md` : Git/브랜치/커밋/코드 스타일 규칙 |
There was a problem hiding this comment.
문서 간 참고 링크 섹션에서 "docs/CONVENTIONS.md"가 누락되어 있습니다. README.md와 다른 문서들에서는 CONVENTIONS.md를 참조하고 있으므로, 일관성을 위해 여기에도 추가하는 것이 좋습니다.
| - `docs/CONVENTIONS.md` : Git/브랜치/커밋/코드 스타일 규칙 | |
| - [CONVENTIONS](./CONVENTIONS.md) : Git/브랜치/커밋/코드 스타일 규칙 |
🔗 관련 이슈
Resolves: #
📝 작업 내용
docs/SETUP.md: 개발 환경 및 테스트 빌드 설치docs/ARCHITECTURE.md: 프로젝트 구조/규칙/Orvaldocs/GUIDE_FEATURE.md: 새 기능 추가 가이드 + FAQdocs/TROUBLESHOOTING.md: 문제 해결 가이드📷 스크린샷 (UI 작업인 경우)
Android
iOS
💬 리뷰어에게
문서 분리 구조와 링크 흐름이 적절한지 확인 부탁드립니다.
✅ 기본 체크리스트
yarn start빌드 에러 없음)console.log나 주석을 제거했나요?yarn format을 실행하여 코드 스타일을 정렬했나요?yarn lint를 실행하여 린트 에러가 없나요?🏗️ 구조 체크리스트 (Self-Check)
파일 및 폴더
features/안에 두었나요? (❌shared/ui금지)shared/ui에 두었나요?index.ts방지)상태 관리 & 네이밍
is,has,should로 시작하나요?🚀 모든 체크리스트를 확인한 후 PR을 생성하세요!