Skip to content

Issue: (#1) 폴더 구조 예시 추가 #2

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

Merged
merged 1 commit into from
Apr 2, 2025

Conversation

HoyeongJeon
Copy link
Collaborator

@HoyeongJeon HoyeongJeon commented Apr 1, 2025

✅ PR 유형

어떤 변경 사항이 있었나요?

  • 새로운 기능 추가
  • 버그 수정
  • 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
  • 코드 리팩토링
  • 주석 추가 및 수정
  • 문서 수정
  • 빌드 부분 혹은 패키지 매니저 수정
  • 파일 혹은 폴더명 수정
  • 파일 혹은 폴더 삭제

📝 작업 내용

이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

auth

  • application : 파사드
  • domain : 도메인
    • entity : 엔티티
    • repository : 레포지토리
    • service : 도메인 서비스
    • value : 값객체
  • infrastructure : 구현체(서드파티, 외부 라이브러리 등등)
  • presentation : 표현계층 (컨트롤러)
    • request/response : dto

✏️ 관련 이슈


🎸 기타 사항 or 추가 코멘트

하다가 헷갈리면 물어봐!!

Summary by CodeRabbit

  • 신규 기능
    • 향후 인증 관련 기능 확장을 위한 기반 작업이 추가되었습니다. 이번 업데이트는 사용자 인터페이스에 즉각적인 변화를 주지 않지만, 향상된 백엔드 인증 처리를 위한 준비 작업의 일환입니다.

@HoyeongJeon HoyeongJeon self-assigned this Apr 1, 2025
Copy link

coderabbitai bot commented Apr 1, 2025

개요

이 PR은 gomushin.backend.auth.presentation 패키지 내에 새로운 Kotlin 파일 ApiPath.kt를 추가합니다. 해당 파일에는 현재 비어있는 ApiPath 객체가 선언되어 있으며, 별도의 속성이나 메서드는 포함되어 있지 않습니다.

변경 사항

파일 경로 변경 요약
src/main/kotlin/gomushin/backend/auth/presentation/ApiPath.kt ApiPath 객체 선언 추가

Poem

나는 작은 토끼, 코드 숲을 달려 🐰
ApiPath가 열어준 새 길, 반짝이는 꿈
빈 객체에 숨은 가능성, 조용히 피어나
한 줄 한 줄 새겨지는 희망의 발자국
햇살 같은 코드와 함께 즐겁게 뛰노네
오늘도 새롭게 피어나는 변화의 노래!

✨ 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.
    • 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

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.

@HoyeongJeon HoyeongJeon requested a review from kimyeoungrok April 1, 2025 15:59
Copy link

@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: 0

🧹 Nitpick comments (1)
src/main/kotlin/gomushin/backend/auth/presentation/ApiPath.kt (1)

3-4: 빈 객체 ApiPath에 대한 주의.
현재 ApiPath 객체는 기능을 구현하지 않은 빈 객체입니다. 만약 이후 API 경로와 관련된 상수나 메서드를 추가할 예정이라면, 추후 확장을 위한 TODO 주석이나 간단한 설명을 추가하는 것이 좋겠습니다. 이는 detekt 경고를 완화하는 동시에, 코드의 의도를 명확히 하는 데 도움이 됩니다.

🧰 Tools
🪛 detekt (1.23.7)

[warning] 3-4: The class or object ApiPath is empty.

(detekt.empty-blocks.EmptyClassBlock)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e07c15b and 0366de3.

📒 Files selected for processing (1)
  • src/main/kotlin/gomushin/backend/auth/presentation/ApiPath.kt (1 hunks)
🧰 Additional context used
🪛 detekt (1.23.7)
src/main/kotlin/gomushin/backend/auth/presentation/ApiPath.kt

[warning] 3-4: The class or object ApiPath is empty.

(detekt.empty-blocks.EmptyClassBlock)

🔇 Additional comments (1)
src/main/kotlin/gomushin/backend/auth/presentation/ApiPath.kt (1)

1-2: 패키지 선언 확인.
패키지 선언 구문은 명확하게 작성되어 있으며, 네임스페이스도 올바르게 세팅되어 있습니다.

Copy link
Contributor

@kimyeoungrok kimyeoungrok left a comment

Choose a reason for hiding this comment

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

~/value하고, ~/infrastructure에는 어떤 역할을 하는 클래스들이 담기는지 궁금해!

Copy link
Contributor

Choose a reason for hiding this comment

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

여기에는 controller역할을 하는 클래스가 담긴다고 이해하면 될까?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

여기에는 controller역할을 하는 클래스가 담긴다고 이해하면 될까?

맞아!

@HoyeongJeon
Copy link
Collaborator Author

HoyeongJeon commented Apr 2, 2025

~/value하고, ~/infrastructure에는 어떤 역할을 하는 클래스들이 담기는지 궁금해!

Value 에는 VO를 넣으면 되는데, 아래 블로그 참고하면 더 이해하기 쉬울 듯!! 이런 값들 + Enum 이정도로 넣어 나는!

https://ksh-coding.tistory.com/m/83

infrastructure 는 외부에서 사용하는 라이브러리 코드나, interface 구현체 정도! 만약 OpenAI를 쓰거나 OCR을 쓰면 해당 구현체 들을 넣으면 돼!
아래 블로그 참고하면 좋을 듯!

https://devfunny.tistory.com/m/875

@HoyeongJeon HoyeongJeon merged commit 73e8085 into main Apr 2, 2025
1 check passed
@HoyeongJeon HoyeongJeon deleted the issue/#1-folder-structure branch April 2, 2025 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

폴더 구조 예시 추가
2 participants