From a4d7daabaad3852d2e09a56865a7470c1c98b113 Mon Sep 17 00:00:00 2001 From: Pierre Jacquier Date: Tue, 1 Sep 2026 11:42:28 -0400 Subject: [PATCH 1/2] Guidance for PR descriptions Context: https://kittycadworkspace.slack.com/archives/C0AU74TS2GP/p1787760669570639 --- AGENTS.md | 9 +++++++++ rust/AGENTS.md | 2 +- src/AGENTS.md | 2 +- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000000..c298a355233 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,9 @@ +# AGENTS.md (Repository) + +## Scope + +This file applies to all work in this repository. More-specific `AGENTS.md` files supplement it with guidance for their directories. + +## Pull requests + +- Keep PR descriptions focused on information useful to reviewers: what changed, why, risks, and any non-obvious behavior or testing context. Do not add boilerplate validation sections listing routine tests, lints, or formatters; CI already reports those. Mention validation only when it adds specific, reviewer-relevant information. diff --git a/rust/AGENTS.md b/rust/AGENTS.md index bd1b7265cb3..721d7178f5b 100644 --- a/rust/AGENTS.md +++ b/rust/AGENTS.md @@ -2,7 +2,7 @@ ## Scope -This file applies to Rust development under `rust/`. It complements the repo root `CONTRIBUTING.md` and `rust/kcl-lib/README.md`. +This file applies to Rust development under `rust/`. It supplements the repo root `AGENTS.md`, `CONTRIBUTING.md`, and `rust/kcl-lib/README.md`. ## Project overview diff --git a/src/AGENTS.md b/src/AGENTS.md index 01149d58b40..670f20ac3f0 100644 --- a/src/AGENTS.md +++ b/src/AGENTS.md @@ -2,7 +2,7 @@ ## Scope -This file applies to TypeScript and React development under `src/`. It complements the repo root `CONTRIBUTING.md` and `eslint.config.mjs`. A series of guiding development principles are available in `PRINCIPLES.md`. +This file applies to TypeScript and React development under `src/`. It supplements the repo root `AGENTS.md`, `CONTRIBUTING.md`, and `eslint.config.mjs`. A series of guiding development principles are available in `PRINCIPLES.md`. ## Project overview From 9b4e7e7f244d46496be8f9d008f0ac63e9e367af Mon Sep 17 00:00:00 2001 From: Pierre Jacquier Date: Tue, 1 Sep 2026 13:30:20 -0400 Subject: [PATCH 2/2] Add notes about draft and CI --- AGENTS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index c298a355233..1fb84868952 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,3 +7,5 @@ This file applies to all work in this repository. More-specific `AGENTS.md` file ## Pull requests - Keep PR descriptions focused on information useful to reviewers: what changed, why, risks, and any non-obvious behavior or testing context. Do not add boilerplate validation sections listing routine tests, lints, or formatters; CI already reports those. Mention validation only when it adds specific, reviewer-relevant information. +- Open agent-created PRs as drafts and leave them in draft until the human who requested the work has self-reviewed them and marked them ready. At minimum, CI should be passing before the PR leaves draft. +- Do not modify CI configuration merely to make a feature or fix PR pass. Fix the implementation or tests instead. If the CI configuration itself is wrong, raise a separate issue and address it in a separate PR.