Files
DongHyeonka dd194784c3
main / main-check (push) Successful in 8m35s
docs: 별도 repo 라이브러리로서의 지침·작업 문서·릴리스 절차를 쓴다
옮겨 온 문서는 템플릿 안의 family를 전제로 쓰였다. 루트 지침은
하네스 뼈대의 빈 양식이고, 모듈 지침·제품 문서는 템플릿 경로
(src/platforms/messaging, src/config/…, cd src)와 템플릿 소비자
(app-bootstrap, adapter:*, composition:*)를 이 repo 안의 것처럼 부른다.

- AGENTS.md(38줄)·CLAUDE.md: 꼭 지킬 것 일곱(api 모듈 순수성, 템플릿
  타입·경로 금지, 배포 버전·적용된 migration 불변, 인증 manifest 손으로
  고치지 않기 등), 지도, 맡은 일, 검증 진입점.
- README.md: 받는 법(exclusiveContent dev.cakit), migration 위치, 지원 표
  (Boot 4.0.9, kafka-clients 4.1.2, apache/kafka:4.1.0, PostgreSQL 16,
  Java 21), 구조, 문서 지도, 서명 공개 키(지문 …A1C936D7F791F8AB,
  grpc-library와 같은 키), 이력(템플릿 2959eff0에서 filter-repo).
- CHANGELOG.md: 1.0.0 절과 템플릿 안 코드에서 옮기는 법(패키지,
  Kafka 설정 키, Gradle 좌표, 바뀌지 않는 것).
- docs/README.md, docs/work/{README,gates,release}.md,
  docs/problem-statement.md: grpc-library와 같은 모양으로, 메시징의
  인증 증거 게이트·migration 규칙·템플릿과 같이 고치는 경로를 넣었다.
  docs/vision.md는 소유자가 쓸 자리라 비워 둔다.
- messaging/AGENTS.md, docs/messaging/*, starter README: registry 경로를
  이 repo 기준으로, 템플릿 쪽 경로·타입은 「백엔드 템플릿의」로 밝혔다.
  시험이 읽는 문장(지원 표의 broker·버전, 설정 참조의 YAML)은 바꾸지
  않았다.

검증: scripts/verify.sh docs rc=0(vision.md 자리 알림만). desktop
mainCheck는 이 커밋 직전 트리에서 rc=0이었다. 문서가 시험에 읽히는
부분은 다음 desktop 실행으로 다시 본다.

Refs: design-docs repo-structure/05-library-repos.md 14.2절
2026-11-08 16:16:38 +09:00

39 lines
3.2 KiB
Markdown

# AGENTS.md — messaging-library의 정본
Spring Boot 앱에 브로커 중립 메시징(발행·소비, outbox·inbox, 재시도·DLQ, 브로커 인증 증거)을 붙이는 라이브러리다(Maven group `dev.cakit.messaging`). 백엔드 템플릿에서 2026-11-08에 이력째 옮겨 왔다. 왜 따로 두는지와 받는 법은 `README.md`, 풀 문제는 `docs/problem-statement.md`다.
## 꼭 지킬 것 — 하나라도 어기면 동작해도 완료가 아니다
1. 관련 검증(아래 「검증」) 없이, 또는 돌리지 못한 이유를 밝히지 않고 완료를 말한다.
2. 요청 범위 밖의 큰 리팩터링, 사용자 변경 되돌리기, 요청 없는 파괴적 명령을 한다.
3. 비밀 값(`.env`, 키, 토큰)을 읽거나 커밋한다. 배포 토큰·서명 키는 repo secret에만 있다.
4. `*-api` 모듈(`messaging-core-api`, `-policy`, `-reliability-api`, `-transport-spi`)이 Java 표준 라이브러리 밖 타입을 쓰거나, Spring이 조립 경계(`*-spring-boot-starter*`, `reliability-jdbc-postgresql`) 밖으로 나간다. 표는 `messaging/AGENTS.md`.
5. 백엔드 템플릿의 타입이나 파일 경로에 기댄다. 필요하면 edge 없는 복사본을 두고 이유를 적는다.
6. 배포한 버전을 지우거나 같은 버전을 다시 올린다. 적용된 migration(`db/migration/messaging/V*.sql`)의 내용이나 위치를 바꾼다.
7. 공개 타입·설정 키(`app.messaging.*`)를 바꾸면서 버전 규칙(`docs/work/release.md` 2절)을 따르지 않는다. 인증 manifest를 손으로 고친다.
## 지도
- `messaging/`: 모듈. 모듈 목록·경로·허용 의존의 정본은 registry `config/architecture/modules.json`이다. 개수는 적지 않는다. family 규칙은 `messaging/AGENTS.md`.
- `build-logic/`: 템플릿에서 복사해 줄인 convention 플러그인. 출처와 고친 것은 `build-logic/UPSTREAM.md`.
- `build.gradle`: 단계 태스크(`ci`·`mainCheck`·`releaseCheck`·`release`). `.gitea/workflows/`는 단계마다 Gradle 한 줄이다.
- `scripts/`: 고정 도구(`tool.sh`), 릴리스 보조(`release/`), 검증 진입점(`verify.sh`).
- 살아 있는 제품 문서는 `docs/messaging/`, 설계 기록은 `docs/design/`, 장부는 `docs/ledger/`. 지도는 `docs/README.md`.
## 맡은 일
- 고치기·리뷰 → `docs/work/README.md`, 게이트 고르기 → `docs/work/gates.md`, 릴리스 → `docs/work/release.md`.
- 템플릿과 같이 고치기(composite build), 소비자 영향 확인 → `docs/work/README.md` 3절.
- brief가 있으면 brief의 범위·크기·완료 기준이 먼저다.
## 검증
- 진입점: `scripts/verify.sh <단계>`(docs · unit · pr · main · release). 사람·CI·에이전트가 같은 명령을 쓴다.
- Gradle·Docker는 소유자 환경에서 desktop에서만 돈다: `scripts/verify.sh pr --on desktop`.
## 일하는 방식
- 착수할 때 예측을, 끝날 때 실측을 `docs/ledger/estimates.jsonl`에 남긴다(Claude Code는 `estimate` 스킬).
- 파일을 바꾸는 위임은 하위 세션에, 결과만 받는 일은 서브에이전트에 맡긴다.
- 커밋·PR 규칙: design-docs `conventions/commit-and-pr.md`(PR 본문 칸은 `.gitea/pull_request_template.md`).