docs : ReadMe 작성 #151
docs : ReadMe 작성 #151
Conversation
Kimminu7
requested review from
NCookies,
chat26666,
minjee2758,
pokerbearkr and
thezz9
WalkthroughREADME 파일이 완전히 교체되어, "EzCode" 프로젝트에 대한 포괄적인 문서로 대체되었습니다. 새로운 문서에는 프로젝트 개요, 팀 역할, 일정, 주요 기능, 서비스 설명, 아키텍처, 기술 스택, 시스템 구조, CI/CD, 그리고 외부 링크가 포함되어 있습니다. Changes
Suggested labels
Poem
Warning Review ran into problems🔥 ProblemsCheck-run timed out after 90 seconds. Some checks/pipelines were still in progress when the timeout was reached. Consider increasing the reviews.tools.github-checks.timeout_ms value in your CodeRabbit configuration to allow more time for checks to complete. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
readme.md (4)
34-42: MD007 경고(리스트 들여쓰기) 해결 제안서브 리스트가 4-스페이스로 들여쓰기 되어 있어 markdownlint 경고가 발생합니다. 2 스페이스로 맞추면 가독성과 규칙 준수 모두 개선됩니다.
- - 이메일 및 비밀번호, 소셜 로그인(Google, GitHub) + - 이메일 및 비밀번호, 소셜 로그인(Google, GitHub)다른 항목(37, 39, 41행)도 동일하게 수정해 주세요.
106-124: 코드 블록에 언어 지정 및 하드탭 제거언어 미지정으로 MD040 경고가 발생하며, 하드탭(120, 122행)도 MD010 경고 대상입니다.
-``` +```text @@ -│ └── exception // 도메인 예외 +│ └── exception // 도메인 예외 @@ - └── persistence // 영속성 (JPA repository, querydsl 등) + └── persistence // 영속성 (JPA repository, querydsl 등)
text지정으로 문법 하이라이트를 방지하면서도 규칙을 충족할 수 있습니다.
140-151: 용어 오탈자 및 명칭 통일
행 현재 제안 143 Elastic search Elasticsearch 150 Git Actions GitHub Actions 테크 스택 표의 공식 명칭을 맞춰 주세요.
3-3: 이미지 대체 텍스트(alt) 추가 권장접근성을 위해 모든 이미지에 alt 속성을 제공하는 것이 좋습니다. 예시:
- +다른 이미지(89, 95, 128, 134행)에도 동일 원칙을 적용해 주세요.
Also applies to: 89-89, 95-95, 128-128, 134-134
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
reademeimage/ci_cd.pngis excluded by!**/*.pngreademeimage/erd.pngis excluded by!**/*.pngreademeimage/img.pngis excluded by!**/*.pngreademeimage/logo.pngis excluded by!**/*.pngreademeimage/systemArchitecture.pngis excluded by!**/*.png
📒 Files selected for processing (1)
readme.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: chat26666
PR: ezcode-my/backend#37
File: src/main/java/org/ezcode/codetest/infrastructure/elasticsearch/repository/ProblemElasticsearchRepositoryDsl.java:10-10
Timestamp: 2025-06-06T19:56:27.759Z
Learning: When user chat26666 mentions that code was implemented in a previous PR but explanation was missing, they may submit a follow-up PR just to add documentation/explanation without the actual implementation code.
readme.md (2)
Learnt from: chat26666
PR: ezcode-my/backend#37
File: src/main/java/org/ezcode/codetest/infrastructure/elasticsearch/repository/ProblemElasticsearchRepositoryDsl.java:10-10
Timestamp: 2025-06-06T19:56:27.759Z
Learning: When user chat26666 mentions that code was implemented in a previous PR but explanation was missing, they may submit a follow-up PR just to add documentation/explanation without the actual implementation code.
Learnt from: thezz9
PR: ezcode-my/backend#114
File: src/main/java/org/ezcode/codetest/infrastructure/github/GitHubApiClient.java:159-165
Timestamp: 2025-06-28T02:03:38.693Z
Learning: User thezz9's service (ezcode) targets Korean users exclusively ("찐 한국인밖에 안 옴"), so Korean language hardcoding in commit messages and UI elements is intentional and appropriate for their use case.
🪛 markdownlint-cli2 (0.17.2)
readme.md
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
106-106: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
120-120: Hard tabs
Column: 18
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 20
(MD010, no-hard-tabs)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (1)
readme.md (1)
3-3: 이미지 경로 오타 가능성 확인 요청
reademeimage폴더명에 오타가 있을 가능성이 있습니다. 실제 디렉터리가readmeimage등 다른 이름이라면 모든 이미지가 깨지게 됩니다.- +경로가 맞는지 한 번 더 확인해 주세요.
작업 내용
변경 사항
트러블 슈팅
해결해야 할 문제
참고 사항
코드 리뷰 전 확인 체크리스트
type :)Summary by CodeRabbit