Files
clean-architecture-backend-…/docs/manual/11-checklist.md
T
DongHyeonka 7140f27948 docs(agents)!: 200줄 넘는 leaf 지역 규칙 셋의 표와 근거를 README로 옮긴다
leaf 지역 규칙(src/**/AGENTS.md)은 그 폴더 파일을 열 때마다 통째로
읽힌다. Claude Code 공식 권장은 지침 파일마다 200줄 이하인데,
persistence-jpa 357줄, application-core 337줄, graphql 218줄이었다. 총괄이
2026-11-07에 상한 200을 검사에 넣고 셋을 줄이기로 정했다(소유자 결정
「자료대로 해 본다」의 방향).

- 참조 표, 계약 세부, 설계 근거를 절 단위로 그 leaf README 끝 「지역
  규칙에서 옮긴 표와 계약」으로 옮겼다(내용 그대로, 제목 한 단계 내림).
  지역 규칙의 같은 자리에는 README 절을 가리키는 줄과 그 폴더를 고칠 때
  지킬 규칙 몇 줄을 남겼다.
  - application-core: 계약 타입, 패키지 소유 표, 정해진 유스케이스 모양,
    멱등성(KEYED) → 337줄에서 190줄.
  - persistence-jpa: Spring 조립 소유, 플랫폼 lane, vendor 고르기,
    TransactionPort 모드표, 영속 실패 번역(SQLState 표), 영속 감사 → 357줄에서
    194줄.
  - graphql: 구현된 플랫폼 범위 등급 표 → 218줄에서 185줄.
- 템플릿 패키지 목록의 정본이 src/application-core/README.md로 옮겨 가서
  TemplatePackageOwnershipDocumentTest가 그 파일을 읽는다. 표를 머리 줄로
  찾고 단언은 그대로다. 옛 경로를 읽으면 표가 없어 실패한다(옮긴 뒤
  AGENTS.md에 표 머리 줄 없음, README에 둘 다 있음을 확인했다). 그 표를
  가리키는 테스트 주석·실패 메시지와 매뉴얼·리뷰 기준·스킬의 참조도 바꿨다.
- persistence-jpa README가 계약 표의 정본을 AGENTS.md라고 적던 줄 넷을 새
  자리로 고쳤다. 그중 「세 템플릿 모두 isolation을 READ_COMMITTED로 고정」은
  코드(`SpringTransaction`: pool에 고정, template은 기본값)와 달라 코드에
  맞췄고, AGENTS.md에 없던 분산 락 provider 선택표 포인터는 실제 설정 코드
  `lock/DistributedLockPersistenceConfig`로 바꿨다.
- check-work-docs.py: src/**/AGENTS.md 200줄 상한(시험 둘). RolePermission
  PolicyTest 주석의 옛 절 이름을 새 규칙 파일로 바꿨다.

위험: 운영 코드 주석 넷(persistence-jpa failure·transaction)은 "CLAUDE.md의
표"를 가리킨다. 업무 코드라 고치지 않았다. CLAUDE.md → AGENTS.md → README
포인터로 닿는다. persistence-jpa README는 V1이 70~72줄을 고친다. 이 커밋은
그 범위를 건드리지 않는다.

검증: check-work-docs(가장 긴 지역 규칙 194/200), check-docs, unittest rc=0.
상한 검사를 끈 사본과 상한을 400으로 올린 사본에서 시험이 실패했다. Java
변경은 최종 트리에서 desktop documentContractTest·ci로 돌린다.

BREAKING CHANGE: 세 leaf의 표가 README로 옮겨 갔다. docs/upgrade/
2026-11-harness.md 2절 8행.
2026-11-07 22:33:08 +09:00

3.3 KiB

11. 체크리스트 — PR 올리기 전

빠진 것이 있으면 해당 장으로 돌아간다. 검사 명령은 src/에서 실행한다.

배치·이름

  • 배치를 03장 기준표로 정했다(기본: 계층 leaf 안 <feature> 패키지).
  • 패키지 이름이 템플릿 패키지(src/application-core/README.md 「패키지 소유 (Package ownership)」)와 겹치지 않고, 업무 코드를 템플릿 패키지에 넣지 않았다.
  • 이름이 src/application-core/AGENTS.md 「Naming convention」을 따른다.

domain

  • 불변식은 aggregate 안에 있고, 위반은 XInvariantException(Reason)이다.
  • id 문법은 id 값 객체 생성자가 검사한다.
  • Spring·JPA·전송 타입을 import하지 않는다.

application

  • 모든 유스케이스에 @UseCaseCapability, 선언과 TransactionPort 호출이 맞다.
  • 쓰기 유스케이스: @RequiresPermission, non-final, bean으로 조립.
  • 외부 호출은 트랜잭션 밖이다.
  • 멱등성 선언을 05장 기준으로 골랐다(재전송될 쓰기는 KEYED).
  • 클라이언트 탓 실패는 carrier 예외 + 기능 코드, 서버 탓은 IllegalStateException.

persistence

  • 저장 adapter가 서비스 전용 persistence leaf에 있다(persistence-jpa 아님).
  • 연관관계는 한쪽만(mappedBy 없음).
  • 중복 규칙은 DB 유일성 제약이 막고, adapter가 그 제약 위반만 기능 예외로 바꾼다.
  • 여러 인스턴스가 집는 작업은 트랜잭션 안 claim + lease.
  • 마이그레이션은 자기 스트림(자기 history table)에 있고, 적용된 파일을 고치지 않았다.
  • adapter가 XRepositoryContract를 실 DB lane에서 상속한다.

inbound

  • 컨트롤러는 변환만 한다. repository·엔티티를 모른다.
  • 경로는 lowerCamel 복수형(AIP-122). 생성은 201 + Location.
  • 도메인 규칙을 DTO bean validation에 다시 쓰지 않았다.

조립·권한

  • XConfig가 @ConditionalOnBean(포트)이고 imports에 한 줄 있다. 포트가 다른 자동 설정에서 오면 afterName.
  • 역할 → 권한 매핑을 app.authz.role-permissions에 더했다.
  • 객체 단위 판정이 필요하면 유스케이스 안에서 하고, 남의 것은 404.

이벤트

  • 저장과 outbox append가 같은 tx.inWrite 안이다.
  • 계약 id·버전·schema·해시를 정했고 계약 bean을 등록했다.

테스트

  • 포트마다 fake 하나와 공유 계약이 포트 소유 leaf testFixtures에 있다.
  • 이름은 행동 문장, @DisplayName은 필요할 때만 한국어, GWT 주석, // when 하나.
  • Docker가 필요한 테스트는 strict lane이고 단계가 있다.

검사

./gradlew <owner-leaf>:check --console=plain        # 건드린 leaf마다
./gradlew architectureCheck --console=plain          # leaf 경계를 넘었으면
./gradlew verifyPublicPathSnapshot                   # 공개 경로가 바뀌었으면
./gradlew :app-bootstrap:verifyEnvKeys               # env 키가 바뀌었으면
./gradlew verifyDependencyLocks                      # 의존성이 바뀌었으면
  • 실행한 명령과 결과를 PR 본문 「검증」에 적었다. 못 돌린 것은 이유와 함께 적었다.