feat : Feedback 스키마 변경 #27
Conversation
Walkthrough이번 PR에서는 피드백 도메인 관련 클래스와 열거형의 구조에 변경이 있었습니다. 새로운 클래스인 ✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 7
🧹 Nitpick comments (3)
src/main/java/depromeet/onepiece/feedback/domain/FeedbackPerPage.java (1)
9-12: 클래스 문서화 개선이 필요합니다.현재 주석이 MongoDB 문서 저장에 대해서만 언급하고 있습니다. 클래스의 목적과 책임을 명확히 설명하는 문서화가 필요합니다.
다음과 같이 개선하는 것을 제안합니다:
-/** 확장을 고려해서 일단 document로 저장 */ +/** + * 페이지별 피드백 정보를 관리하는 도메인 클래스입니다. + * <p> + * 각 페이지는 고유한 페이지 번호와 해당 페이지에 대한 여러 피드백 내용을 포함합니다. + * MongoDB 문서로 저장되며, 향후 확장성을 고려한 구조를 가지고 있습니다. + */또한 객체 생성을 위한 Builder 패턴 추가를 고려해 주세요:
@Builder public class FeedbackPerPage { // ... }src/main/java/depromeet/onepiece/feedback/domain/FeedbackType.java (1)
8-16: 피드백 타입에 대한 문서화 개선 필요각 피드백 타입의 사용 목적과 적용 시나리오에 대한 자세한 설명이 있으면 좋겠습니다.
각 enum 값에 Javadoc을 추가하는 것을 제안합니다:
public enum FeedbackType { + /** + * 번역체나 어색한 표현을 지적할 때 사용 + * 예시: "~하는 것이 되겠습니다" -> "~합니다" + */ TRANSLATION_OR_AWKWARD("번역체/어색한 표현"), + /** + * 문장의 길이가 과도하거나 이해하기 어려운 표현을 수정할 때 사용 + * 예시: 긴 문장을 여러 문장으로 나누거나 복잡한 표현을 단순화 + */ LENGTH_OR_READABILITY("문장이 길거나 가독성이 떨어지는 표현 수정"), // ... 나머지 타입들에 대해서도 동일하게 문서화src/main/java/depromeet/onepiece/feedback/domain/ProjectEvaluation.java (1)
11-33: MongoDB 인덱스 추가를 고려해주세요.
projectName은 조회 조건으로 자주 사용될 것으로 예상됩니다. MongoDB 컬렉션에 인덱스를 추가하여 조회 성능을 개선하는 것을 추천드립니다.@Document(collection = "project_evaluation") @CompoundIndex(def = "{'project_name': 1}") public class ProjectEvaluation { // ... }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
src/main/java/depromeet/onepiece/feedback/domain/EvaluationDetail.java(1 hunks)src/main/java/depromeet/onepiece/feedback/domain/EvaluationType.java(0 hunks)src/main/java/depromeet/onepiece/feedback/domain/FeedbackContent.java(1 hunks)src/main/java/depromeet/onepiece/feedback/domain/FeedbackPerPage.java(2 hunks)src/main/java/depromeet/onepiece/feedback/domain/FeedbackPerProject.java(0 hunks)src/main/java/depromeet/onepiece/feedback/domain/FeedbackType.java(1 hunks)src/main/java/depromeet/onepiece/feedback/domain/OverallEvaluation.java(1 hunks)src/main/java/depromeet/onepiece/feedback/domain/ProjectEvaluation.java(1 hunks)
💤 Files with no reviewable changes (2)
- src/main/java/depromeet/onepiece/feedback/domain/EvaluationType.java
- src/main/java/depromeet/onepiece/feedback/domain/FeedbackPerProject.java
🔇 Additional comments (1)
src/main/java/depromeet/onepiece/feedback/domain/ProjectEvaluation.java (1)
1-8: 패키지 구조와 임포트가 잘 구성되어 있습니다!도메인 계층에 맞게 패키지가 구성되어 있으며, 필요한 임포트들이 잘 정리되어 있습니다.
src/main/java/depromeet/onepiece/feedback/domain/FeedbackContent.java
Outdated
Show resolved
Hide resolved
src/main/java/depromeet/onepiece/feedback/domain/ProjectEvaluation.java
Outdated
Show resolved
Hide resolved
#️⃣ 관련 이슈
💡 작업내용
Feedback 스키마 수정
📝 기타
현재 UT용 피그마를 보고 FeedbackType을 아래 5개로 지정해놨는데 추후 확정된 후 변경해야 합니다.