Skip to content

docs: 공지 도메인 정책 가이드 추가#572

Merged
dh2906 merged 1 commit intodevelopfrom
docs/notice-domain-guide
Apr 25, 2026
Merged

docs: 공지 도메인 정책 가이드 추가#572
dh2906 merged 1 commit intodevelopfrom
docs/notice-domain-guide

Conversation

@dh2906
Copy link
Copy Markdown
Contributor

@dh2906 dh2906 commented Apr 25, 2026

🔍 개요

  • 공지 도메인에서 AI 작업 시 지켜야 할 목록/상세 조회, 읽음 이력, 생성/수정/삭제 정책을 코드 기준으로 정리했습니다.
  • 문서 claim 중 목록 조회가 읽음 이력을 만들지 않는 정책을 통합 테스트로 고정했습니다.

🚀 주요 변경 내용

  • src/main/java/gg/agit/konect/domain/notice/AGENTS.md를 추가해 공지 도메인의 주요 상태, 기능 동작, 테스트 기준을 문서화했습니다.
  • 공지 목록 조회가 CouncilNoticeReadHistory를 생성하지 않는지 검증하는 통합 테스트를 추가했습니다.
  • 기존 read history count 검증 로직을 helper로 정리해 반복 조회 테스트와 신규 테스트가 같은 기준을 쓰도록 했습니다.

💬 참고 사항

  • 확인한 테스트: CI=true ./gradlew test --tests 'gg.agit.konect.integration.domain.notice.*'
  • 확인한 검사: git diff --check, push 전 hook의 checkstyleMaincompileJava
  • ./gradlew checkstyleTest는 기존 club/notification/chat 테스트의 line length 위반으로 실패했으며, 이번 변경 파일에서 새로 발생한 위반은 없습니다.

✅ Checklist (완료 조건)

  • 코드 스타일 가이드 준수
  • 테스트 코드 포함됨
  • Reviewers / Assignees / Labels 지정 완료
  • 보안 및 민감 정보 검증 (API 키, 환경 변수, 개인정보 등)

- 공지 목록, 상세 조회, 읽음 이력, 생성/수정/삭제 정책을 코드 기준으로 정리
- notice 작업 시 대학별 공지 격리와 read history 중복 방지, unread count 연계를 함께 확인하도록 기준화
- 문서 claim 중 목록 조회가 읽음 이력을 만들지 않는 정책을 통합 테스트로 고정
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 25, 2026

Warning

Rate limit exceeded

@dh2906 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 11 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 14 minutes and 11 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2dee9168-4067-4ecf-927b-833e8311f8c5

📥 Commits

Reviewing files that changed from the base of the PR and between b7da0ab and bd15de4.

📒 Files selected for processing (2)
  • src/main/java/gg/agit/konect/domain/notice/AGENTS.md
  • src/test/java/gg/agit/konect/integration/domain/notice/NoticeApiTest.java
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/notice-domain-guide

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

🧪 JaCoCo Coverage Report (Changed Files)

이 PR에서 변경된 main Java 소스 파일이 없습니다.

📊 View Workflow Run

@dh2906 dh2906 self-assigned this Apr 25, 2026
@dh2906 dh2906 added the 문서 문서화와 관련된 이슈입니다. label Apr 25, 2026
@dh2906 dh2906 requested a review from Copilot April 25, 2026 07:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

공지(Notice) 도메인의 정책(목록/상세 조회, 읽음 이력, CRUD, unread count)을 코드 기준으로 문서화하고, “공지 목록 조회는 읽음 이력을 생성하지 않는다”는 정책을 통합 테스트로 고정하는 PR입니다.

Changes:

  • 공지 목록 조회CouncilNoticeReadHistory를 생성하지 않는지 검증하는 통합 테스트 추가
  • read history count 검증 로직을 테스트 helper 메서드로 공통화
  • 공지 도메인 정책/동작/테스트 기준을 AGENTS.md로 문서화

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/test/java/gg/agit/konect/integration/domain/notice/NoticeApiTest.java 목록 조회 시 read history 미생성 정책을 통합 테스트로 고정하고, read history count 조회 로직을 helper로 정리
src/main/java/gg/agit/konect/domain/notice/AGENTS.md 공지 도메인의 핵심 정책/동작/회귀 테스트 포인트를 코드 기준으로 정리한 가이드 문서 추가

@dh2906 dh2906 merged commit 65ae8f7 into develop Apr 25, 2026
9 checks passed
@dh2906 dh2906 deleted the docs/notice-domain-guide branch April 25, 2026 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

문서 문서화와 관련된 이슈입니다.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants