Skip to content

[feature] 지원서의 설명을 확인할 수 있다.#556

Merged
lepitaaar merged 3 commits intodevelop/befrom
feature/application-description
Jul 20, 2025
Merged

[feature] 지원서의 설명을 확인할 수 있다.#556
lepitaaar merged 3 commits intodevelop/befrom
feature/application-description

Conversation

@lepitaaar
Copy link
Contributor

@lepitaaar lepitaaar commented Jul 19, 2025

#️⃣연관된 이슈

#555

📝작업 내용

  • 지원서의 길이제한을 증가시켰습니다.
  • 지원서에 description 필드를 추가하였습니다

중점적으로 리뷰받고 싶은 부분(선택)

리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요

ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?

논의하고 싶은 부분(선택)

논의하고 싶은 부분이 있다면 작성해주세요.

🫡 참고사항

Summary by CodeRabbit

  • 신규 기능

    • 동아리 지원서에 설명(Description) 입력 및 표시 기능이 추가되었습니다.
  • 개선 사항

    • 지원서 제목 입력 가능 글자 수가 20자에서 50자로 확대되었습니다.
    • 지원서 설명 입력란이 추가되어 최대 500자까지 작성할 수 있습니다.
    • 지원서 질문 및 답변의 제목과 값 입력 가능 글자 수가 20자에서 200자로 확대되었습니다.

추가로 각각 질문과 지원서의 제한 길이를 증가시켰습니다
추가로 각각 질문과 지원서의 제한 길이를 증가시켰습니다
@lepitaaar lepitaaar self-assigned this Jul 19, 2025
@lepitaaar lepitaaar added ✨ Feature 기능 개발 📬 API 서버 API 통신 작업 💾 BE Backend labels Jul 19, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 19, 2025

"""

Walkthrough

신규 description(설명) 필드가 동아리 지원서 관련 엔티티, 요청/응답 레코드, 서비스 로직에 추가되었습니다. 기존 제목(title) 및 질문(questions) 필드의 길이 제한도 확장되었습니다. 서비스 계층에서 설명 필드의 저장 및 응답 반환이 반영되었습니다.

Changes

파일 그룹 변경 요약
.../entity/ClubQuestion.java description 필드 및 업데이트 메서드 추가
.../payload/request/ClubApplicationCreateRequest.java
.../payload/request/ClubApplicationEditRequest.java
description 필드 추가, title 필드 길이 제한 20→50자로 확장
.../payload/request/ClubApplyQuestion.java title, value 필드 길이 제한 20→200자로 확장
.../payload/response/ClubApplicationResponse.java description 필드 추가
.../service/ClubApplyService.java 설명 필드 저장/반환 로직 추가, 컬렉션 import 정리

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller
    participant ClubApplyService
    participant ClubQuestion(Entity)
    
    Client->>Controller: 지원서 생성/수정 요청(title, description, questions)
    Controller->>ClubApplyService: create/editClubApplication(request)
    ClubApplyService->>ClubQuestion: updateFormTitle(request.title)
    ClubApplyService->>ClubQuestion: updateFormDescription(request.description)
    ClubApplyService->>ClubQuestion: updateQuestions(request.questions)
    ClubApplyService->>Controller: 완료 응답
    Controller->>Client: 결과 반환
Loading
sequenceDiagram
    participant Client
    participant Controller
    participant ClubApplyService
    participant ClubQuestion(Entity)

    Client->>Controller: 지원서 조회 요청
    Controller->>ClubApplyService: getClubApplication()
    ClubApplyService->>ClubQuestion: getTitle(), getDescription(), getQuestions()
    ClubApplyService->>Controller: ClubApplicationResponse(title, description, questions)
    Controller->>Client: 지원서 데이터 반환
Loading

Possibly related issues


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd915ce and 27a7da2.

📒 Files selected for processing (1)
  • backend/src/main/java/moadong/club/entity/ClubQuestion.java (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • backend/src/main/java/moadong/club/entity/ClubQuestion.java
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link

github-actions bot commented Jul 19, 2025

Test Results

75 tests   66 ✅  1s ⏱️
12 suites   0 💤
12 files     9 ❌

For more details on these failures, see this check.

Results for commit 27a7da2.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
backend/src/main/java/moadong/club/service/ClubApplyService.java (1)

23-23: 명시적 import 사용을 권장합니다.

와일드카드 import (java.util.*) 대신 사용되는 클래스들을 명시적으로 import하는 것이 좋습니다. 명시적 import는 코드 가독성을 높이고 네이밍 충돌을 방지합니다.

-import java.util.*;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dea11cf and bd915ce.

📒 Files selected for processing (6)
  • backend/src/main/java/moadong/club/entity/ClubQuestion.java (2 hunks)
  • backend/src/main/java/moadong/club/payload/request/ClubApplicationCreateRequest.java (1 hunks)
  • backend/src/main/java/moadong/club/payload/request/ClubApplicationEditRequest.java (1 hunks)
  • backend/src/main/java/moadong/club/payload/request/ClubApplyQuestion.java (2 hunks)
  • backend/src/main/java/moadong/club/payload/response/ClubApplicationResponse.java (1 hunks)
  • backend/src/main/java/moadong/club/service/ClubApplyService.java (4 hunks)
🧰 Additional context used
🧠 Learnings (6)
backend/src/main/java/moadong/club/payload/response/ClubApplicationResponse.java (2)
Learnt from: lepitaaar
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/service/ClubApplyService.java:34-38
Timestamp: 2025-05-19T05:45:52.957Z
Learning: The code duplication between createClubApplication and editClubApplication methods in ClubApplyService.java is acknowledged but will be addressed in a future refactoring, as per the developer's plan.
Learnt from: Zepelown
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/entity/ClubApplicationQuestion.java:32-33
Timestamp: 2025-05-15T12:03:57.356Z
Learning: 엔티티 클래스는 요청/응답 객체(DTO)에 의존해서는 안 됩니다. 계층 간 의존성 문제를 방지하기 위해 엔티티와 DTO는 분리되어야 합니다. 예를 들어, `ClubApplicationQuestion` 엔티티가 `ClubApplicationRequest.Options`와 같은 요청 객체를 직접 참조하는 대신, 엔티티 패키지 내에 `QuestionOptions`와 같은 별도의 클래스를 정의하고 사용해야 합니다. 이렇게 하면 요청 객체 변경이 데이터베이스 스키마나 엔티티 계층에 영향을 미치지 않습니다.
backend/src/main/java/moadong/club/payload/request/ClubApplyQuestion.java (1)
Learnt from: lepitaaar
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/service/ClubApplyService.java:34-38
Timestamp: 2025-05-19T05:45:52.957Z
Learning: The code duplication between createClubApplication and editClubApplication methods in ClubApplyService.java is acknowledged but will be addressed in a future refactoring, as per the developer's plan.
backend/src/main/java/moadong/club/payload/request/ClubApplicationCreateRequest.java (1)
Learnt from: lepitaaar
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/service/ClubApplyService.java:34-38
Timestamp: 2025-05-19T05:45:52.957Z
Learning: The code duplication between createClubApplication and editClubApplication methods in ClubApplyService.java is acknowledged but will be addressed in a future refactoring, as per the developer's plan.
backend/src/main/java/moadong/club/entity/ClubQuestion.java (1)
Learnt from: lepitaaar
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/service/ClubApplyService.java:34-38
Timestamp: 2025-05-19T05:45:52.957Z
Learning: The code duplication between createClubApplication and editClubApplication methods in ClubApplyService.java is acknowledged but will be addressed in a future refactoring, as per the developer's plan.
backend/src/main/java/moadong/club/payload/request/ClubApplicationEditRequest.java (1)
Learnt from: lepitaaar
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/service/ClubApplyService.java:34-38
Timestamp: 2025-05-19T05:45:52.957Z
Learning: The code duplication between createClubApplication and editClubApplication methods in ClubApplyService.java is acknowledged but will be addressed in a future refactoring, as per the developer's plan.
backend/src/main/java/moadong/club/service/ClubApplyService.java (2)
Learnt from: lepitaaar
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/service/ClubApplyService.java:34-38
Timestamp: 2025-05-19T05:45:52.957Z
Learning: The code duplication between createClubApplication and editClubApplication methods in ClubApplyService.java is acknowledged but will be addressed in a future refactoring, as per the developer's plan.
Learnt from: Zepelown
PR: Moadong/moadong#406
File: backend/src/main/java/moadong/club/entity/ClubApplicationQuestion.java:32-33
Timestamp: 2025-05-15T12:03:57.356Z
Learning: 엔티티 클래스는 요청/응답 객체(DTO)에 의존해서는 안 됩니다. 계층 간 의존성 문제를 방지하기 위해 엔티티와 DTO는 분리되어야 합니다. 예를 들어, `ClubApplicationQuestion` 엔티티가 `ClubApplicationRequest.Options`와 같은 요청 객체를 직접 참조하는 대신, 엔티티 패키지 내에 `QuestionOptions`와 같은 별도의 클래스를 정의하고 사용해야 합니다. 이렇게 하면 요청 객체 변경이 데이터베이스 스키마나 엔티티 계층에 영향을 미치지 않습니다.
🔇 Additional comments (12)
backend/src/main/java/moadong/club/entity/ClubQuestion.java (1)

48-50: updateFormDescription 메서드 구현이 적절합니다

기존 updateFormTitle 메서드와 일관된 패턴으로 잘 구현되었습니다.

backend/src/main/java/moadong/club/payload/response/ClubApplicationResponse.java (1)

11-11: 응답 DTO에 description 필드 추가가 적절합니다

필드 배치가 논리적이고(title, description, questions 순서) 요청 DTO들과 일관성을 유지하고 있습니다.

backend/src/main/java/moadong/club/payload/request/ClubApplyQuestion.java (2)

16-16: 질문 제목 길이 제한 확장이 적절합니다

20자에서 200자로 확장하여 더 상세한 질문 제목을 작성할 수 있게 되었습니다. 기존 제한이 너무 제한적이었으므로 개선된 변경사항입니다.


35-35: 질문 항목 값 길이 제한 확장이 적절합니다

QuestionItem의 value 필드도 20자에서 200자로 확장하여 질문 제목과 일관성을 유지하고 있습니다.

backend/src/main/java/moadong/club/payload/request/ClubApplicationCreateRequest.java (2)

12-12: 제목 길이 제한 확장이 적절합니다

20자에서 50자로 확장하여 더 의미 있는 제목을 작성할 수 있게 되었습니다.


15-17: description 필드 추가가 잘 구현되었습니다

@NotBlank@Size(max = 500) 검증이 적절하게 설정되어 있고, 요청 시 설명을 필수로 입력받도록 하는 것이 합리적입니다.

backend/src/main/java/moadong/club/payload/request/ClubApplicationEditRequest.java (2)

12-12: 제목 길이 제한이 생성 요청과 일관되게 확장되었습니다

ClubApplicationCreateRequest와 동일하게 50자로 설정하여 일관성을 유지하고 있습니다.


15-17: description 필드가 생성 요청과 일관되게 구현되었습니다

ClubApplicationCreateRequest와 동일한 검증 규칙(@NotBlank, @Size(max = 500))을 적용하여 생성과 수정 작업 간 일관성을 보장하고 있습니다.

backend/src/main/java/moadong/club/service/ClubApplyService.java (4)

54-54: 안전한 null 처리가 잘 구현되었습니다.

Optional.ofNullable().orElse("")를 사용하여 description 필드의 null 값을 안전하게 처리하고 있습니다. 응답 객체에 항상 non-null 값을 보장하는 좋은 방어적 프로그래밍 패턴입니다.


191-191: 일관된 패턴으로 description 필드가 잘 추가되었습니다.

기존 updateFormTitle 호출과 동일한 패턴으로 updateFormDescription을 추가하여 일관성을 유지하고 있습니다.


196-198: 기술 부채에 대한 명확한 문서화입니다.

createQuestionsupdateQuestions 메서드 간의 코드 중복 문제를 인지하고 향후 리팩토링 계획을 명시한 것은 좋은 접근입니다. 이전 리뷰에서도 언급된 기술 부채를 적절히 문서화하고 있습니다.


229-229: create 메서드와 일관된 구현입니다.

createQuestions 메서드와 동일한 패턴으로 description 업데이트를 추가하여 생성과 수정 작업 간의 기능적 일치성을 유지하고 있습니다.

@oesnuj oesnuj removed the request for review from Due-IT July 20, 2025 10:14
Copy link
Member

@seongwon030 seongwon030 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

지원서 설명 필드 추가 좋습니다

Copy link
Member

@Zepelown Zepelown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

고생하셨습니다.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📬 API 서버 API 통신 작업 💾 BE Backend ✨ Feature 기능 개발

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments