|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +`git-ranker`는 Git Ranker의 backend API 서버 저장소다. workflow repo는 orchestration만 소유하고, backend 구현과 verification/deploy entrypoint의 canonical source는 이 저장소가 직접 소유한다. |
| 4 | + |
| 5 | +## 시작 순서 |
| 6 | + |
| 7 | +1. `README.md`에서 프로젝트 목적과 high-level overview를 확인한다. |
| 8 | +2. `build.gradle`, `settings.gradle`에서 모듈 구조, 의존성, verification task를 확인한다. |
| 9 | +3. `.github/workflows/ci.yml`, `.github/workflows/deploy.yml`에서 CI verification lane과 pre-deploy gate를 확인한다. |
| 10 | +4. `src/test/java/`에서 current verification slice를 본다. |
| 11 | + - `*IT.java`는 Testcontainers 기반 integration lane이다. |
| 12 | +5. `src/main/java/`, `src/main/resources/`에서 실제 구현과 runtime config를 읽는다. |
| 13 | + |
| 14 | +## Source Of Truth |
| 15 | + |
| 16 | +- repo overview: `README.md` |
| 17 | +- build and verification entrypoint: `build.gradle` |
| 18 | +- CI / deploy gate: `.github/workflows/ci.yml`, `.github/workflows/deploy.yml` |
| 19 | +- backend behavior and contracts: `src/main/java/`, `src/test/java/` |
| 20 | +- runtime container surface: `Dockerfile`, `docker-compose.yml` |
| 21 | + |
| 22 | +## 운영 원칙 |
| 23 | + |
| 24 | +- backend 구현 세부사항은 workflow repo 문서가 아니라 이 저장소의 문서, 설정, 코드, 테스트가 canonical source다. |
| 25 | +- root `README.md`는 개요만 유지한다. concrete bootstrap, verification, entrypoint 설명은 `AGENTS.md`와 named entry docs가 맡는다. |
| 26 | +- 현재 verification baseline command set은 `./gradlew test`, `./gradlew integrationTest`, packaging check `./gradlew build`다. |
| 27 | +- `./gradlew build`만으로는 `integrationTest`가 실행되지 않는다. CI/deploy gate는 이 순서를 명시적으로 호출하고, workflow에서는 마지막 packaging check를 `./gradlew build -x test`로 실행해 중복 unit test를 피한다. |
| 28 | +- `integrationTest`는 Docker/Testcontainers 전제를 가진다. 로컬 환경에서 Docker가 없으면 CI evidence와 함께 해석한다. |
| 29 | +- verification lane이나 deploy gate를 바꾸면 `build.gradle`, workflow YAML, `AGENTS.md`를 함께 맞춘다. |
| 30 | +- 현재 repo-local `.codex/skills/`는 없다. 별도 skill이 없을 때는 이 문서와 nearest code/test를 먼저 읽고 진행한다. |
0 commit comments