Skip to content

Guidance for PR descriptions #13557

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

Merged
pierremtb merged 2 commits into from
Sep 1, 2026
+13 −2
Merged

Guidance for PR descriptions #13557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4d7daa
Guidance for PR descriptions
pierremtb Sep 1, 2026
9b4e7e7
Add notes about draft and CI
pierremtb Sep 1, 2026
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
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 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.
- 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.
2 changes: 1 addition & 1 deletion rust/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading