Files
clean-architecture-backend-…/docs/manual/11-checklist.md
T
DongHyeonka 08f932123a docs(agents)!: leaf 지역 규칙 문서를 같은 폴더 AGENTS.md로 옮긴다
leaf·family 지역 규칙은 지금 src/**/CLAUDE.md에만 있어서 Claude Code
밖의 에이전트는 이 규칙을 정본 이름으로 찾지 못한다. 소유자가
2026-11-07에 루트와 하위 폴더 모두 AGENTS.md를 정본으로 정했다
(design-docs harness/01-harness-design.md 13절 Q1·Q2).

- 28개 파일을 git mv로 같은 폴더 AGENTS.md로 옮기고, 그 자리
  CLAUDE.md에는 `@AGENTS.md` 한 줄만 둔다. 이 세션에서
  src/domain-core 파일을 열자 CLAUDE.md의 가져오기가 펼쳐져
  AGENTS.md 본문이 함께 읽히는 것을 확인했다. 그래서 Claude Code는
  지금처럼 그 폴더를 만질 때 규칙을 읽는다.
- 버린 대안: 심볼릭 링크(Edit 도구가 링크를 통해 쓰지 않는다),
  CLAUDE.md 그대로 두기(다른 에이전트가 못 찾는다).
- 살아 있는 문서와 테스트 코드의 leaf 규칙 경로를 새 이름으로 바꿨다.
  기록 문서(evidence, upgrade, design, history, reviews, adr)는 쓴
  때의 경로를 그대로 둔다.
- link-check workflow(lychee)는 src/**/CLAUDE.md만 본다. 내용이
  AGENTS.md로 가면 상대 링크가 검사 밖으로 나가므로, PR마다 도는
  check-docs.py에 살아 있는 문서 전체의 상대 링크 검사를 더했다.
  workflow는 CI 재편 몫이라 고치지 않았다.
- check-work-docs.py의 이력 ID 검사도 src/**/AGENTS.md를 본다.

위험: git은 이 커밋을 "CLAUDE.md 수정 + AGENTS.md 추가"로 본다(같은
이름의 새 파일이 생겨 이름 바꾸기로 잡히지 않는다). 옛 이력은
`git log -- <폴더>/CLAUDE.md`로 본다. 코드 주석의 "CLAUDE.md"는
가져오기를 거쳐 같은 문서에 닿으므로 운영 코드는 고치지 않았다.

검증: python3 scripts/check-docs.py, python3 scripts/check-work-docs.py,
python3 -m unittest discover -s scripts/tests 모두 rc=0. 링크 검사
시험은 검사 조건을 끈 사본에서 7건 중 3건이 실패했다.

BREAKING CHANGE: 파생 서비스의 leaf 규칙 문서 이름이 AGENTS.md로
바뀐다. 동기화 뒤 각 leaf의 CLAUDE.md는 `@AGENTS.md` 한 줄이다.
2026-11-07 21:58:12 +09:00

3.2 KiB

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

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

배치·이름

  • 배치를 03장 기준표로 정했다(기본: 계층 leaf 안 <feature> 패키지).
  • 패키지 이름이 템플릿 패키지(src/application-core/AGENTS.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 본문 「검증」에 적었다. 못 돌린 것은 이유와 함께 적었다.