Skip to content

Claude 설정 문서의 낡은 서술 정리 - #1178

Open
m-a-king wants to merge 2 commits into
devfrom
docs/claude-md-stale-cleanup
Open

m-a-king wants to merge 2 commits into
devfrom
docs/claude-md-stale-cleanup

Conversation

@m-a-king

@m-a-king m-a-king commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Situation

설정 문서 감사 결과

  • CLAUDE.md 와 .claude/rules/ 5개·마이그레이션 CLAUDE.md 를 현재 코드와 대조
    • 결과: 없는 타입·팩토리를 가리키는 예시, 틀린 수치, 로비 규칙과 부딪히는 워크트리 절차가 남음
  • 로비에서 hop 한 세션에는 프로젝트 settings.json 훅이 돌지 않음
    • 결과: "훅이 막으니 산문으로 반복하지 않는다" 는 서술이 hop 세션에서 규칙 공백을 만듦

Task

낡은 서술 정리

  • 낡은 서술은 삭제
  • 지우면 정보가 사라지는 자리는 현재 사실로 교체

Action

코드와 다른 예시·수치 교체

대상 이전 이후
domain-exception.md 예시 WishException(message, category, httpStatus)·alreadyExists() *ErrorCode 엔트리 하나에서 파생하는 실제 모양·notFound()
testing-convention.md stub 예시 없는 StubProductExtractor·ProductExtractor StubProductLinkExtractor·ProductLinkExtractor·ProductSnapshot
db-schema.md 엔티티 22개 중 6개와 glob 나열 frontmatter paths 포인터, paths 에 metrics/** 추가
openapi-controller.md 어드민 범위 컨트롤러 이름 나열(3개 누락) admin/** 컨트롤러 전부(클래스에 @Hidden)
ApiResponseBody 예외 3xx 하나 3xx·SSE 구독
트랜잭션 분리 예시 WishlistService.registerFromUrl(이제 추출 안 함) AsyncItemParsingWorker 에서 ItemParsingService 로 위임
CLAUDE.md 예외 예시 없는 TournamentException.alreadyCompleted() repo 에 없는 가상 예시로 명시
마이그레이션 CLAUDE.md 마이그레이션 전부 additive additive 는 순서 무관

사실이 바뀐 서술 교체

대상 이전 이후
main 브랜치 옛 상태에 머묾 prod 승격 전용(promote.yml)
브랜치 보호 구멍 관리자 직접 push 우회 관리자의 PR 머지 시 필수 체크 우회·승인 요구 0
워크트리 생성·진입 git -C 격리·name= 경고 base 는 origin/dev, 진입 방식은 분리 질문에서 확인
워크트리 정리 이벤트별 수동 정리·타이머 금지 /session-close(clean·머지된 현재 자리만), 수동도 --force 없이
가드 훅 서술 훅이 막으니 반복하지 않음 hop 세션에서는 직접 지킴, 화살표 오른쪽이 옳은 형태
자동 로드 대상 파일·glob 나열(어긋남) frontmatter paths 포인터
테스트 원칙 목차 infra 정본 목차 복제 정본 위치 포인터만
테스트 원칙 참조 "테스트 분류" 절 "분기 위치 결정 트리" (3)

삭제

종류 대상
이력 #728 미배정 현황 · #986·#988 · create_init_schema squash 예외 · iam.tf 주석의 "배포 공통화 등급 C"
반복 null 비교 금지 재진술 · "한 줄 외울 것" · 마이그레이션 순서 보장 재진술
일반론 self-invocation 절 · SLF4J placeholder 절
복제 ItemSnapshot 필드 목록
시점 조건 Kotest·Strikt "이후 도입 검토"
  • self-invocation 절과 SLF4J 절은 각각 트랜잭션 예시와 Logger 선언에 한 문장으로 흡수

Result

범위

  • 범위: require 의 status 서술은 보류
    • 원인: 문서는 500, GlobalExceptionHandler 는 400. 문서와 핸들러 중 어느 쪽을 맞출지 결정 대기
  • 범위: terraform/iam.tf 는 주석 한 줄만 수정, terraform fmt -check 통과
  • 후속: 코드 주석 정리는 이 PR 밖
    • WishErrorCode.kt 의 #728 참조
    • StubProductLinkExtractor.kt 의 옛 절 위치 참조
    • ExtractionModelProbe.kt 의 extractor docs/api-contract.md 참조

연관 이슈

- CLAUDE.md
  - main 브랜치 설명을 prod 승격 전용으로 교체
    - 원인: main 은 promote.yml 의 승격 대상
  - worktree 생성·진입·정리 절차를 로비 규칙과 /session-close 참조로 축약
    - 원인: git -C 격리·EnterWorktree name= 서술이 로비 규칙과 충돌
  - 도메인 예외 예시를 가상 Order 예시로 교체
    - 원인: TournamentException.alreadyCompleted·complete(winnerWishItemId) 가 코드에 없음
  - 반복 서술 삭제: null 금지 반복 줄·한 줄 외울 것·self-invocation 일반론·SLF4J 설명·ItemSnapshot 컬럼 나열
  - 매퍼 분기 참조를 분기 위치 결정 트리 (3) 으로 교체
  - 응답 래퍼 예외에 SSE 구독 추가
  - 웹 요청 경계 훅 서술에 hop 세션 직접 준수 추가
    - 원인: 로비에서 hop 한 세션에는 프로젝트 훅이 돌지 않음
- .claude/rules/domain-exception.md
  - 예외 생성 예시를 ErrorCode 기반 WishException 모양으로 교체
    - 원인: ErrorCode 이관 전 생성자 모양 잔존
  - 없는 팩토리 alreadyExists 를 notFound 로 교체
  - 나쁜 예 이름을 invalidValue 로 바꿈
    - 원인: 실존 팩토리 untrustworthyValue 와 이름 겹침
  - 자동 로드 파일 나열을 frontmatter paths 참조로 교체
  - 에픽 #728 참조 삭제
- .claude/rules/openapi-controller.md
  - 어드민 컨트롤러 나열을 admin/** 전체 지칭으로 교체
    - 원인: 나열 밖 어드민 컨트롤러 존재
  - SSE 구독의 SseEmitter 직접 반환 예외 추가
- .claude/rules/db-schema.md
  - 엔티티 개수 수치 삭제
    - 원인: 22개 중 6개 수치 불일치
  - paths 에 metrics 패키지 추가
    - 원인: metrics/registration/WishExternalEntry 가 엔티티
- .claude/rules/testing-convention.md
  - stub 예시를 StubProductLinkExtractor 실물 타입으로 교체
    - 원인: StubProductExtractor·ProductExtractor·Product 타입 없음
  - 게이트 우회 구멍 서술을 관리자 머지 시 체크 건너뜀으로 교체
    - 원인: ruleset 이 dev 직접 push 를 막음
  - Kotest·Strikt 도입 검토 문구 삭제
- .claude/rules/web-request-boundary.md
  - 훅 차단 항목에 hop 세션 직접 준수 추가
  - 이슈 번호 괄호 삭제
- src/main/resources/db/migration/CLAUDE.md
  - out-of-order 근거를 additive 한정으로 교체
    - 원인: 순서 의존 마이그레이션도 존재
  - squash 예외 문장 삭제
@m-a-king m-a-king added the docs 문서만 만지는 작업 label Sep 29, 2026
@m-a-king m-a-king self-assigned this Sep 29, 2026
@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Repository: TeamPiKi/core/.coderabbit.yml

Review profile: CHILL

Plan: Advanced

Run ID: c1cee6c2-16b1-4feb-be79-ed6f129926ab

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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.

@github-actions

Copy link
Copy Markdown

Discord 스레드 연동용 메타데이터입니다. discord-pr-bot 워크플로가 자동 생성하며, 수정·삭제하면 PR 과 Discord 알림 연동이 끊깁니다.

- CLAUDE.md 트랜잭션 분리 예시를 AsyncItemParsingWorker·ItemParsingService 로 교체
  - 원인: WishlistService.registerFromUrl 은 추출 없이 itemRegistrar.accept 후 persist 만 수행
- CLAUDE.md worktree 절의 로비 규칙 재서술 제거
  - 원인: 바로 위 문단과 중복
- CLAUDE.md 정리 불릿에 session-close 대상 범위 추가·타이머 문장 삭제
- CLAUDE.md 테스트 절의 infra 정본 목차 괄호 삭제
  - 원인: 정본 목차 복제
- openapi-controller.md·CLAUDE.md openapi 절의 glob 나열을 frontmatter paths 참조로 교체
- openapi-controller.md 어드민 예외 서술을 클래스 @hidden 기준으로 정정
  - 원인: DiscordAccessController 는 화면이 아닌 Discord 인터랙션 엔드포인트
- db-schema.md 본문의 glob 재나열을 frontmatter paths 참조로 교체
- db/migration/CLAUDE.md 순서 의존 변경 문장 삭제
  - 원인: 다음 불릿과 중복
- web-request-boundary.md 훅 절 도입문 갱신
  - 원인: hop 세션에는 차단 메시지 자체가 없음
- testing-convention.md 원칙 목차 복제 삭제
- terraform/iam.tf 주석의 배포 공통화 등급 표기 삭제
  - 원인: infra 규약에서 등급 개념 삭제

This branch has not been deployed

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

Labels

docs 문서만 만지는 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant