From 7a04e0fb8db85f77aedf52455832ae9d5ab2c569 Mon Sep 17 00:00:00 2001 From: Tony Deng Date: Fri, 19 Jun 2026 18:07:15 -0700 Subject: [PATCH] docs: add agent PR guidance --- AGENTS.md | 13 +++++++++++++ CLAUDE.md | 1 + 2 files changed, 14 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..dc4d57f55 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,13 @@ +# Agent Guidance + +## Pull Request Hygiene + +- Use Conventional Commits format for PR titles and commit subjects. Follow https://www.conventionalcommits.org/en/v1.0.0/#summary with a lowercase type, optional scope, colon, and short imperative summary, for example `fix(devbox): remove stale helper argument`. +- Match the repository's existing release style when choosing a type and scope. Prefer `fix(scope): ...`, `feat(scope): ...`, `docs(scope): ...`, or `chore(scope): ...` as appropriate. +- When asked to create, open, or update a PR, do not hand the turn back to the user until the branch is pushed, the PR is open or updated, relevant local validation has run where practical, and GitHub CI is passing. +- If CI cannot pass because of an external service, permissions, unavailable secrets, or another blocker outside the branch changes, report the blocking check with a link and a concise explanation. + +## Generated Code + +- Most SDK code is generated. Prefer fixing generated API surfaces at the OpenAPI/Stainless source when possible. +- Keep handwritten changes small and clearly separated from generated updates so future generations can be reviewed safely. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 000000000..47dc3e3d8 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file