Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: enum 및 변수명 canceled로 통일 #814

Merged
merged 2 commits into from
Nov 1, 2024

Conversation

Sangwook02
Copy link
Member

@Sangwook02 Sangwook02 commented Oct 29, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • cancelled와 canceled가 혼용되고 있어서 canceled로 통일했습니다.

📝 참고사항

  • main으로 머지할 때 db에 enum값 수정해줘야 합니다~

📚 기타

Summary by CodeRabbit

  • 버그 수정

    • "CANCELLED" 상수를 "CANCELED"로 변경하여 일관성을 유지했습니다.
    • 관련 메서드 및 변수 이름을 업데이트하여 영국식 영어에서 미국식 영어로 전환했습니다.
  • 문서화

    • 코드 내에서 "CANCELLED" 대신 "CANCELED"를 사용하여 모든 관련 문서화 및 주석을 수정했습니다.

@Sangwook02 Sangwook02 added the ♻️ refactor 기능 개선 label Oct 29, 2024
@Sangwook02 Sangwook02 self-assigned this Oct 29, 2024
@Sangwook02 Sangwook02 requested a review from a team as a code owner October 29, 2024 12:26
Copy link

coderabbitai bot commented Oct 29, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

이 풀 리퀘스트에서는 StudyStatus 열거형의 상수 이름을 CANCELLED에서 CANCELED로 변경하는 작업이 포함되어 있습니다. 이 변경은 Assignment, Curriculum, AssignmentSubmissionStatusResponse, AttendanceStatusResponse, StudyStudentResponse, ErrorCode 등 여러 클래스와 열거형에서 일관되게 반영되었습니다. 또한 관련 메서드와 변수 이름도 수정되어, 전체적으로 미국식 영어 표기법으로 통일되었습니다.

Changes

파일 경로 변경 요약
src/main/java/com/gdschongik/gdsc/domain/study/domain/StudyStatus.java 상수 CANCELLEDCANCELED로 변경
src/main/java/com/gdschongik/gdsc/domain/study/domain/vo/Assignment.java 메서드 canceled(), isCanceled(), validateSubmittable에서 CANCELLEDCANCELED로 변경
src/main/java/com/gdschongik/gdsc/domain/study/domain/vo/Curriculum.java 메서드 isCancelled()isCanceled()로 변경
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentSubmissionStatusResponse.java 상수 CANCELLEDCANCELED로 변경, 메서드 내부 로직 수정
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentSubmittableDto.java 메서드 isCancelled()isCanceled()로 변경, 내부 로직 수정
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AttendanceStatusResponse.java 상수 CANCELLEDCANCELED로 변경
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/StudyStudentResponse.java 변수 cancelledAssignmentsCount, cancelledAttendanceCount를 각각 canceledAssignmentsCount, canceledAttendanceCount로 변경
src/main/java/com/gdschongik/gdsc/global/exception/ErrorCode.java 상수 ASSIGNMENT_SUBMIT_CANCELLEDASSIGNMENT_SUBMIT_CANCELED로 변경
src/test/java/com/gdschongik/gdsc/domain/study/application/MentorStudyDetailServiceTest.java 변수 cancelledStudyDetailcanceledStudyDetail로 변경
src/test/java/com/gdschongik/gdsc/domain/study/domain/StudyDetailTest.java 테스트 메서드에서 StudyStatus.CANCELLEDStudyStatus.CANCELED로 변경
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/StudyTaskResponse.java 메서드 로직에서 "Cancelled"를 "Canceled"로 변경

Assessment against linked issues

Objective Addressed Explanation
CANCELLED 상수의 이름을 CANCELED로 변경 (이슈 #799)
관련 메서드와 변수의 이름을 일관되게 변경

Possibly related PRs

Suggested reviewers

  • seulgi99
  • AlmondBreez3
  • uwoobeat

🐇 변화의 바람이 불어와
"CANCELLED"는 이제 잊어버려!
"CANCELED"로 모두 함께 외쳐,
일관된 언어로 세상을 만들어!
코드는 깔끔하게, 마음은 가볍게,
새로운 이름으로 모두를 반겨! 🎉


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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

Copy link

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link
Member

@kckc0608 kckc0608 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

@uwoobeat uwoobeat left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link

github-actions bot commented Nov 1, 2024

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

@Sangwook02 Sangwook02 merged commit adf7c95 into develop Nov 1, 2024
1 check passed
@Sangwook02 Sangwook02 deleted the refacor/799-rename-canceled branch November 1, 2024 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
♻️ refactor 기능 개선
Projects
None yet
Development

Successfully merging this pull request may close these issues.

♻️ 휴강 enum 값 CANCELED로 워딩 통일
3 participants