Skip to content

docs(AGENTS.md): cross-reference remaining project README files #13035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jsonmp-k8 wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −4
Open

docs(AGENTS.md): cross-reference remaining project README files #13035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

### Document metadata

- Last updated: 2026-03-09
- Last updated: 2026-03-13
- Scope: KFP master branch (v2 engine), backend (Go), SDK (Python), frontend (React 17)

### Maintenance (agents and contributors)
Expand Down Expand Up @@ -37,6 +37,7 @@

- Always sign off on commits with `git commit -s` (adds a `Signed-off-by:` trailer).
- Never include AI agents (e.g. Claude Code, Copilot, or similar tools) as co-authors on commits. The human author is responsible for the work.
- See `CONTRIBUTING.md` at the repo root for DCO sign-off requirements and general PR conventions.

## Baseline architecture

Expand Down Expand Up @@ -167,6 +168,8 @@ KFP supports two main deployment modes:
- Includes user isolation, namespace-based access control, and Istio integration
- Suitable for production environments with multiple users/teams

See `manifests/kustomize/README.md` for full installation options and environment-specific instructions.

## Local testing

- Python (SDK):
Expand Down Expand Up @@ -199,6 +202,7 @@ Notes:

- API Server tests under `backend/test/v2/api` are integration tests run with Ginkgo; they require a running cluster and are not part of unit tests.
- Compiler tests live under `backend/test/compiler` and E2E tests under `backend/test/end2end`; both are Ginkgo-based and excluded from unit presubmits.
- See `test/README.md` for integration/E2E test infrastructure details (Kind clusters, GitHub Actions setup).

### Backend Ginkgo test suites

Expand Down Expand Up @@ -281,7 +285,8 @@ Notes:

## Regenerate protobufs after schema changes

- Pipeline spec Protobufs live under `api/`.
- Pipeline spec Protobufs live under `api/` (see `api/README.md` for proto code generation details).
- Backend API generation tools and prerequisites are documented in `backend/api/README.md`.
- Run both Python and Go generations:

```bash
Expand Down Expand Up @@ -320,11 +325,11 @@ The following files are generated; edit their sources and regenerate:
- DSL core: `sdk/python/kfp/dsl/` (e.g., `component_factory.py`, `pipeline_task.py`, `pipeline_context.py`)
- Executor entrypoint: `sdk/python/kfp/dsl/executor_main.py`
- Platform integration (Python): `kubernetes_platform/python/kfp/`
- Platform spec proto: `kubernetes_platform/proto/`
- Platform spec proto: `kubernetes_platform/proto/` (see `kubernetes_platform/README.md` for proto generation and library setup)
- API definitions (Protobufs): `api/`
- Backend (API server, driver, launcher, etc.): `backend/` (see `backend/README.md` for build, test, and local development setup)
- Backend test suites: `backend/test/compiler`, `backend/test/v2/api`, `backend/test/end2end`
- Frontend: `frontend/` (React TypeScript, see `frontend/CONTRIBUTING.md`)
- Frontend: `frontend/` (React TypeScript, see `frontend/README.md` for quick start and `frontend/CONTRIBUTING.md` for detailed guidelines)
- Manifests (Kustomize bases/overlays for deployments): `manifests/`
- CI manifests and overlays used by workflows: `.github/resources/manifests/{kubernetes-native,multiuser,standalone}`
- Test data (inputs/goldens): `test_data/pipeline_files/valid/`, `test_data/compiled-workflows/`
Expand Down
3 changes: 3 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Claude Code Configuration

See [AGENTS.md](AGENTS.md) for the full agent and contributor guide — it covers architecture, local development, testing, CI/CD, code style, and commit policies for this repo.
Loading