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` 한 줄이다.
4.8 KiB
4.8 KiB
shared-contract — 골격 전체가 쓰는 운영 계약
등록 정보
- 모듈 ID:
shared-contract - Gradle 경로:
:shared-contract - 이 모듈만 시험(Gradle 경로에서 나온 명령):
./gradlew :shared-contract:test --console=plain - 실행 기준: Java 21. 프레임워크 기준인 Spring Boot 버전은
src/gradle/libs.versions.toml이 정한다. - registry 정본:
src/config/architecture/modules.json.
패키지 루트: dev.caskeleton.shared.
예전에 코드 주석에 두던 설계 결정(오류 코드 분류, 응답 envelope 모양, metric cardinality 한계, tracing 이음매, domain-context 전파)은 README.md에 있다. 이 파일은 모듈 규칙의 정본으로 남는다.
책임 (Responsibility)
- 응답 envelope(
response/Envelope,response/ApiError,response/BulkEnvelope,response/BulkItemResult). - 오류 코드 계약(
error/ApiErrorCode인터페이스,error/OperationalErrorenum,error/ApiErrorCarrier)과 클라이언트에 보여 줄 문구 표 하나(error/ClientErrorMessages. 한국어이고Category마다 문구 하나이며 모든 전송 계층이 쓴다). - 계층을 가로지르는 mapper 표지 예외(
error/MappingException). - 요청 값 계약(
request/Patch). - tracing 계약 타입(
tracing/TraceParent,tracing/SpanErrorRecorder) — W3Ctraceparent값 타입과 span 오류 기록 이음매(feature-distributed-tracing-contract. OTel tracer 런타임은 fork가 켜는 이음매라서 이 타입들은 Java 표준 라이브러리만 쓴다). - 모든 leaf가 복사해 쓰던 표준 라이브러리 도우미(2026-09-25 리뷰 후속으로 여기로 옮겼다):
digest/Sha256(SHA-256 digest 값과 유일한MessageDigest.getInstance("SHA-256")),digest/HmacSha256(서명과 상수 시간 검증),retry/Backoff(상한 있는 지수 ceiling. "full jitter"는U[0, ceiling]이고 다른 뜻이 아니다). 들여온messaging:*와 optional gRPC 빌드는 이 모듈에 의존하지 않고 자기 사본을 둔다. 각 제품의 AGENTS.md가 이유를 적는다(다른 제품이다. 2026-08-14 메시징 모듈 리뷰 뒤에 정했다). 이 도우미가 필요한 템플릿 leaf는 모두shared-contractedge를 두고 복사하지 않고 쓴다. identifier, persistence-mongo, application-objectstorage, redis-sdk가 바로 이 때문에 edge를 받았고(2026-11-03에 정함), 각각 JVM 밖에서 계산한 벡터로 출력을 고정하는 시험이 있다. observability/MdcKeys: 모든 전송 계층(web, GraphQL, STOMP, gRPC)이 요청의 correlation을 넣는 snake_case MDC 키 이름(registrydocs/registries/mdc-keys.yaml).ratelimit/: web edge와 Redis 어댑터 사이에 있는 provider 중립 edge rate-limit 포트 (EdgeRateLimitPort)와 그 값 타입(README 「ratelimit」).security/Permission:AuthorizationPort에 묻는resource:action권한 값(README 「security」).concurrency/: domain-context 전파 포트와 그ThreadLocal기본 구현(README 「concurrency」).runtime/RuntimeEnvironment: 모든 leaf가 「운영 환경인가?」에 답할 때 쓰는 유일한 runtime profile 어휘.metrics/ForbiddenMetricTags: 어떤 metric도 실으면 안 되는 high-cardinality tag 키.- 이 모듈의 패키지는 위가 전부이고 다른 패키지는 둘 수 없다:
ForbiddenApiArchitectureTest.SHARED_CONTRACT_CONTAINS_ONLY_OPERATIONAL_CONTRACT_PACKAGES가dev.caskeleton.shared아래 다른 패키지에 있는 클래스와 루트에 바로 있는 클래스를 거절한다. 루트에는package-info만 있다. 새 계약 패키지는 그 시험의SHARED_CONTRACT_PACKAGES와 이 목록에 함께 넣는다.SharedContractPackageRuleTest는SHARED_CONTRACT_PACKAGES와 모듈의 패키지가 다르면 실패한다. - 계약 시험만 읽는 registry 규칙 사본은
main이 아니라testFixtures에 둔다:metrics/MetricNaming,metrics/CardinalityBounds,metrics/AlertSeverity,tracing/BaggageAllowlist. 운영 코드가 쓰게 될 때만main으로 옮긴다. contracts/messaging/envelope/아래의 범용 메시징 envelope schema 리소스. 전송 중립 envelope metadata만 가진다. 기능 payload schema는 그 기능을 가진 모듈에 남는다. 리소스가 있다고 런타임에 찾아지거나 등록되는 것은 아니다.
허용
- Java 표준 라이브러리만. Spring, Jackson, JPA import는 없다.
금지 (Forbidden)
- 업무·도메인 개념(도메인 오류 코드는 그것을 쓰는 모듈에 둔다).
- 프레임워크 import(HTTP 상태는 전송 중립
int로 나타내고 web 모듈이 대응시킨다). - 메시징 어댑터의 Task 6 validator 검증이 생기기 전에 Draft 2020-12 validator 호환을 주장하기.
테스트
cd src
./gradlew :shared-contract:test