Files
grpc-library/AGENTS.md
T
DongHyeonka ce83f4d550
pr / ci (pull_request) Successful in 1m9s
docs: 별도 repo 라이브러리로서의 지침·작업 문서·릴리스 절차를 쓴다
옮겨 온 문서는 템플릿 안의 optional build를 전제로 했다(`-p
platforms/optional-build`, 템플릿 registry·workflow 경로, "벤더드 플랫폼").
하네스 뼈대의 루트 지침과 문제 정의는 비어 있었다.

- 루트 AGENTS.md(38줄)·CLAUDE.md: 꼭 지킬 것(core-api 순수성, Stable이
  advanced를 안 씀, 템플릿에 기대지 않음, 배포한 버전 불변, 버전 규칙),
  지도, 맡은 일, 검증 진입점. 비대화형 세션의 플러그인 설치 두 줄.
- README: 무엇인가, 받는 법(exclusiveContent), 지원 표, 구조, 문서 지도,
  서명, 이력(filter-repo, 커밋 SHA·리뷰 ID는 템플릿 기준).
- docs/work/README.md·gates.md·release.md: 고치는 법, 단계와 바꾼 것별
  게이트, 템플릿과 같이 고치기(composite), 릴리스와 소유자가 할 일
  (PACKAGES_TOKEN, SIGNING_KEY·SIGNING_PASSWORD, 첫 태그 v1.0.0).
- CHANGELOG.md(1.0.0 미발행, 옮기는 법), docs/README.md(지도, 머리 블록).
- scripts/verify.sh: unit·pr·main·release 단계. 라이브러리라 app은 없다.
- 살아 있는 문서(grpc·grpc-advanced AGENTS.md, 지원 매트릭스, runbook):
  경로·패키지·optional build 문장을 이 repo 기준으로. ADR·설계서 본문은
  기록이라 고치지 않았다.
- docs/vision.md는 소유자가 쓰는 문서라 비워 두었다.

검증: scripts/verify.sh docs rc=0(AGENTS.md 38줄, 장부 JSON).
2026-11-08 11:22:12 +09:00

2.9 KiB

AGENTS.md — grpc-library의 정본

Spring Boot 앱에 gRPC 서버·클라이언트를 붙이는 플랫폼 라이브러리다(Maven group com.hyeonworks.grpc). 백엔드 템플릿에서 2026-11-08에 이력째 옮겨 왔다. 왜 따로 두는지와 받는 법은 README.md, 풀 문제는 docs/problem-statement.md다.

꼭 지킬 것 — 하나라도 어기면 동작해도 완료가 아니다

  1. 관련 검증(아래 「검증」) 없이, 또는 돌리지 못한 이유를 밝히지 않고 완료를 말한다.
  2. 요청 범위 밖의 큰 리팩터링, 사용자 변경 되돌리기, 요청 없는 파괴적 명령을 한다.
  3. 비밀 값(.env, 키, 토큰)을 읽거나 커밋한다. 배포 토큰·서명 키는 repo secret에만 있다.
  4. grpc-core-api가 io.grpc·Spring·protobuf·JPA 타입을 쓰거나, Stable 모듈(grpc/*)이 grpc-advanced/*를 쓴다.
  5. 백엔드 템플릿의 타입이나 파일 경로에 기댄다. 필요하면 edge 없는 복사본을 두고 이유를 그 모듈 build.gradle에 적는다.
  6. 배포한 버전을 지우거나 같은 버전을 다시 올린다. 잘못 나갔으면 다음 PATCH를 낸다.
  7. 공개 타입·proto를 바꾸면서 버전 규칙(docs/work/release.md 2절)을 따르지 않는다.

지도

  • grpc/(Stable)·grpc-advanced/(capability flag 뒤): 모듈. 모듈 목록·경로·허용 의존의 정본은 registry config/architecture/modules.json이다. 개수는 적지 않는다.
  • build-logic/: 템플릿에서 복사해 줄인 convention 플러그인. 어디서 복사했고 무엇을 고쳤는지는 build-logic/UPSTREAM.md.
  • build.gradle: 단계 태스크(ci·mainCheck·releaseCheck·release). .gitea/workflows/는 단계마다 Gradle 한 줄이다.
  • scripts/: 고정 도구(tool.sh), Buf(buf.sh), 릴리스 보조(release/), 검증 진입점(verify.sh).
  • 폴더마다의 규칙은 그 폴더의 AGENTS.md다(grpc/, grpc-advanced/, build-logic/). 결정 기록은 docs/adr/, 장부는 docs/ledger/.

맡은 일

  • 고치기·리뷰 → 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).