Skip to content

Commit 1d131ec

Browse files
committed
docs: add agent PR guidance
1 parent ef1eb3a commit 1d131ec

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Agent Guidance
2+
3+
## Pull Request Hygiene
4+
5+
- 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`.
6+
- 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.
7+
- 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.
8+
- 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.
9+
10+
## Generated Code
11+
12+
- Most SDK code is generated. Prefer fixing generated API surfaces at the OpenAPI/Stainless source when possible.
13+
- Keep handwritten changes small and clearly separated from generated updates so future generations can be reviewed safely.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)