docs : README 개선#554
Conversation
- 서비스 소개, 브랜치 전략, 도메인 기능, 기술스택, 폴더구조, 인프라 구조도 추가 - 1:1 멘토링 vs 프리미엄스터디 도메인 혼동 주의 섹션 추가 - Mermaid 배포 파이프라인 다이어그램 추가 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 23 minutes and 29 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME 문서의 프로젝트 소개와 목차 구조를 재편성하고, 로컬 실행 가이드(요구사항·설치·명령어·환경 변수), 브랜치 전략·CI 체크, 제품 도메인 재정리, 기술 스택 및 버전 업데이트, 폴더 구조 재구성, OpenAPI 훅 생성 안내, 인프라 다이어그램 및 배포 환경 표를 추가·갱신했습니다. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 66-68: The README contains fenced code blocks without language
tags (triggering markdownlint MD040) around the branch diagram "main ◄───
develop ◄─── feat/*, fix/*, refactor/*, docs/*, chore/* ...", the feature/fix
examples starting with "feat : 새 기능 → feat/기능명" and the project tree
beginning with "src/"; update each triple-backtick fence to include a language
identifier (e.g., ```text) so the blocks are explicitly tagged and MD040
warnings are resolved, keeping the block contents unchanged.
- Line 67: Branch naming rules are inconsistent: the header branch list (main
◄─── develop ◄─── feat/*, fix/*, refactor/*, docs/*, chore/* ...) is missing
style/* and test/* which are allowed later; update the README.md branch strategy
to be consistent by either adding style/* and test/* to the primary list
(alongside feat/*, fix/*, refactor/*, docs/*, chore/* under the heading that
includes main and develop) or remove style/* and test/* from the allowed rules
further down (the block that currently mentions allowed patterns) so both places
list the same set of branch prefixes (referencing the symbols main, develop,
feat/*, fix/*, refactor/*, docs/*, chore/*, style/*, test/*).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
♻️ Duplicate comments (2)
README.md (2)
66-68:⚠️ Potential issue | 🟡 Minor
fenced code block에 언어 태그를 명시해주세요.Line 66, Line 82, Line 154의 코드블록이 언어 미지정이라 MD040 경고가 발생합니다.
```text처럼 언어를 지정해 주세요.수정 예시
-``` +```text main ◄─── develop ◄─── feat/*, fix/*, refactor/*, docs/*, chore/* ...-``` +```text feat : 새 기능 → feat/기능명 ...-``` +```text src/ ├── app/ ...Also applies to: 82-90, 154-186
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 66 - 68, Several fenced code blocks in README.md (the blocks containing the lines "main ◄─── develop ◄─── feat/*, fix/*, refactor/*, docs/*, chore/* ...", the block starting with "feat : 새 기능 → feat/기능명", and the directory tree block beginning with "src/ ├── app/") are missing language tags causing MD040 warnings; update each triple-backtick fence to include a language tag (use ```text) for those specific blocks and the other similar blocks referenced (lines 82-90 and 154-186) so the linter stops flagging them.
67-67:⚠️ Potential issue | 🟡 Minor브랜치 prefix 목록을 한 기준으로 통일해주세요.
Line 67에는
style/*,test/*가 없고, Line 86-89에는 포함되어 있어 규칙 해석이 갈립니다. 둘 중 하나로 통일해 주세요.Also applies to: 83-90
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 67, The branch prefix lists in the README are inconsistent: the sequence "feat/*, fix/*, refactor/*, docs/*, chore/* ..." (as shown in the main ◄─── develop diagram) omits "style/*" and "test/*" while another section includes them; pick one canonical set and make both occurrences identical. Update the README entries that list branch prefixes so that the diagram string "main ◄─── develop ◄─── feat/*, fix/*, refactor/*, docs/*, chore/*, style/*, test/*" (or the shorter set without style/test if you prefer) is used consistently wherever branch prefixes are documented.
🧹 Nitpick comments (1)
README.md (1)
10-13: 배포 환경 표가 중복되어 유지보수 시 드리프트 위험이 있습니다.상단(프론트 2행)과 하단(프론트/백엔드 통합)에서 배포 정보를 이중 관리하고 있어, 추후 한쪽만 수정될 가능성이 큽니다. 한 곳을 source of truth로 두고 다른 위치는 링크/참조로 정리하는 것을 권장합니다.
Also applies to: 287-292
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 10 - 13, The README contains duplicated deployment environment tables (the front-end 2-row table and the integrated front/backend table referenced at lines ~287-292); pick one canonical table (e.g., the integrated front/backend section) and remove the other duplicate, then replace the removed table with a short reference or link to the canonical table (add an anchor or heading like "배포 환경" and link to it) so there is a single source of truth for the staging/production URLs and triggers; update any surrounding text that assumed the removed table so references point to the canonical "배포 환경" table.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@README.md`:
- Around line 66-68: Several fenced code blocks in README.md (the blocks
containing the lines "main ◄─── develop ◄─── feat/*, fix/*, refactor/*, docs/*,
chore/* ...", the block starting with "feat : 새 기능 → feat/기능명", and the
directory tree block beginning with "src/ ├── app/") are missing language tags
causing MD040 warnings; update each triple-backtick fence to include a language
tag (use ```text) for those specific blocks and the other similar blocks
referenced (lines 82-90 and 154-186) so the linter stops flagging them.
- Line 67: The branch prefix lists in the README are inconsistent: the sequence
"feat/*, fix/*, refactor/*, docs/*, chore/* ..." (as shown in the main ◄───
develop diagram) omits "style/*" and "test/*" while another section includes
them; pick one canonical set and make both occurrences identical. Update the
README entries that list branch prefixes so that the diagram string "main ◄───
develop ◄─── feat/*, fix/*, refactor/*, docs/*, chore/*, style/*, test/*" (or
the shorter set without style/test if you prefer) is used consistently wherever
branch prefixes are documented.
---
Nitpick comments:
In `@README.md`:
- Around line 10-13: The README contains duplicated deployment environment
tables (the front-end 2-row table and the integrated front/backend table
referenced at lines ~287-292); pick one canonical table (e.g., the integrated
front/backend section) and remove the other duplicate, then replace the removed
table with a short reference or link to the canonical table (add an anchor or
heading like "배포 환경" and link to it) so there is a single source of truth for
the staging/production URLs and triggers; update any surrounding text that
assumed the removed table so references point to the canonical "배포 환경" table.
- 코드블록 3곳에 ```text 언어 태그 추가 (MD040) - 브랜치 다이어그램에 style/*, test/* 누락 항목 추가하여 명명 규칙과 일치 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 participant
🍀 참고사항
서비스 전반적으로 동기화하면서 Claude와 README 수정해보았습니다.
앞으로도 리팩토링하시겠지만 현재 FE 작업하시는 관점에서 어긋난 내용 있는지, 추가 또는 개선하고 싶은 내용 있는지 코멘트 달아주세요!
☘️ 작업 내용
스크린샷 (선택)
Summary by CodeRabbit
문서 변경사항