ReadMe 수정 #405
Merged
ReadMe 수정 #405
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Failed to generate code suggestions for PR |
WalkthroughREADME.md 파일이 대폭 확장 및 보강되었습니다. 백엔드 팀의 초점을 설명하는 새로운 소개 문장이 추가되었고, ERD 섹션에는 기존의 단일 ERD 이미지 대신 RDS, rental, trade, mypage, Elastic Search 등 여러 상세 ERD 이미지가 추가되었습니다. 아키텍처 이미지는 새로운 버전으로 교체되었습니다. GitHub Wiki 링크에는 trade 관련 기술 블로그 두 개가 추가되었습니다. "협업" 섹션이 신설되어 주요 기능 분담과 프론트엔드와의 Swagger, API 명세 기반 협업 방식이 설명되었습니다. 개발 일정에는 초기 단계와 최종 QA/문서화 단계가 추가되었습니다. "핵심 기능 요약" 섹션이 신설되어 로그인, 대여, 거래, 마이페이지, SOS, 모니터링 등 주요 기능이 정리되었습니다. 마지막으로 역할 분담 항목의 일부 용어가 소폭 수정되었습니다. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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. 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 (2)
README.md (2)
8-20: 이미지 태그에 alt 속성이 없어 접근성 기준(MD045)을 위반합니다
여러 섹션에서<img>태그에alt속성이 빠져 있어 스크린리더 사용자가 내용을 인지하기 어렵습니다. 간단한 대체 텍스트를 추가해 주세요.-<img src="https://github.com/user-attachments/assets/7721441f-692e-497a-a105-c09021ddb369" style="width:100%; height:auto;" /> +<img src="https://github.com/user-attachments/assets/7721441f-692e-497a-a105-c09021ddb369" alt="RDS 전체 ERD" style="width:100%; height:auto;" /> ... -<img src="https://github.com/user-attachments/assets/ec63a52a-15ad-44d0-bb2f-be7b1e243546" style="width:100%; height:auto;" /> +<img src="https://github.com/user-attachments/assets/ec63a52a-15ad-44d0-bb2f-be7b1e243546" alt="대여 ERD" style="width:100%; height:auto;" />동일한 방식으로 14, 17, 20행의 이미지에도 적절한
alt값을 추가해 주세요.
64-65: Wiki 링크 라벨이 동일해 구분이 어렵습니다
두 줄 모두 ‘거래 - 기술 블로그’로 표시되어 있으나, 두 번째 링크는 실제로 ‘대여 - 지도 기술 블로그’ 문서로 보입니다. 표시 문구를 구체적으로 구분해 혼동을 줄여주세요.-<li><a href=".../대여-―-지도-기술-블로그"> ⭐ 거래 - 기술 블로그 </a></li> +<li><a href=".../대여-―-지도-기술-블로그"> ⭐ 대여(지도) - 기술 블로그 </a></li>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: dionisos198
PR: Ureca-Final-Project-Team2/be_badata#388
File: src/main/java/com/TwoSeaU/BaData/domain/rental/service/RestockDeleteTargetingService.java:37-60
Timestamp: 2025-08-05T05:48:10.447Z
Learning: dionisos198는 be_badata 프로젝트에서 PR의 주요 목적에 집중하기 위해 성능 최적화 이슈를 추후 수정으로 미루는 접근 방식을 선호한다. N+1 쿼리 최적화와 같은 성능 개선 사항은 별도 작업으로 분리하여 처리한다.
Learnt from: marineAqu
PR: Ureca-Final-Project-Team2/be_badata#269
File: src/main/java/com/TwoSeaU/BaData/domain/trade/controller/MockController.java:24-27
Timestamp: 2025-07-28T01:53:53.618Z
Learning: marineAqu prefers to keep method names as-is in temporary Mock APIs that are planned for deletion, prioritizing development efficiency over perfect naming conventions for code that will be removed later.
Learnt from: marineAqu
PR: Ureca-Final-Project-Team2/be_badata#365
File: src/main/java/com/TwoSeaU/BaData/domain/trade/service/PostSearchService.java:44-44
Timestamp: 2025-08-03T14:04:42.957Z
Learning: marineAqu는 개별 API의 완벽한 구현보다는 모든 API 간의 일관된 구현 패턴을 유지하는 것을 우선시한다. 보안이나 성능 개선 사항이 있더라도 전체 시스템에 대한 논의 후 일괄 적용하는 것을 선호한다.
Learnt from: marineAqu
PR: Ureca-Final-Project-Team2/be_badata#358
File: src/main/java/com/TwoSeaU/BaData/domain/trade/service/RecommendService.java:155-169
Timestamp: 2025-08-03T04:35:46.490Z
Learning: marineAqu는 곧 삭제될 예정인 API의 경우, 최적화보다는 개발 효율성을 우선시하여 현재 구현을 임시로 유지하는 것을 선호한다. 삭제될 코드에 대해서는 완벽한 구현보다는 개발 속도를 중시한다.
📚 Learning: dionisos198는 be_badata 프로젝트에서 pr의 주요 목적에 집중하기 위해 성능 최적화 이슈를 추후 수정으로 미루는 접근 방식을 선호한다. n+1 쿼리 최적화와 같은 ...
Learnt from: dionisos198
PR: Ureca-Final-Project-Team2/be_badata#388
File: src/main/java/com/TwoSeaU/BaData/domain/rental/service/RestockDeleteTargetingService.java:37-60
Timestamp: 2025-08-05T05:48:10.447Z
Learning: dionisos198는 be_badata 프로젝트에서 PR의 주요 목적에 집중하기 위해 성능 최적화 이슈를 추후 수정으로 미루는 접근 방식을 선호한다. N+1 쿼리 최적화와 같은 성능 개선 사항은 별도 작업으로 분리하여 처리한다.
Applied to files:
README.md
📚 Learning: dionisos198는 be_badata 프로젝트에서 곧 삭제될 예정인 테스트 코드의 경우, 코드 중복이나 최적화보다는 개발 효율성을 우선시한다. 임시 코드에 대해서는 리팩토링을 ...
Learnt from: dionisos198
PR: Ureca-Final-Project-Team2/be_badata#366
File: src/main/java/com/TwoSeaU/BaData/global/fcm/FCMService.java:127-165
Timestamp: 2025-08-03T14:38:19.797Z
Learning: dionisos198는 be_badata 프로젝트에서 곧 삭제될 예정인 테스트 코드의 경우, 코드 중복이나 최적화보다는 개발 효율성을 우선시한다. 임시 코드에 대해서는 리팩토링을 고려하지 않는 것을 선호한다.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.17.2)
README.md
8-8: Images should have alternate text (alt text)
(MD045, no-alt-text)
11-11: Images should have alternate text (alt text)
(MD045, no-alt-text)
14-14: Images should have alternate text (alt text)
(MD045, no-alt-text)
17-17: Images should have alternate text (alt text)
(MD045, no-alt-text)
20-20: Images should have alternate text (alt text)
(MD045, no-alt-text)
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ReadMe를 수정했습니다.