Skip to content

Commit ac80835

Browse files
authored
docs: add coding agent guidance (#81)
## What Add a concise root `AGENTS.md` covering scope, private-generated files, Bazel/Gazelle workflow, release boundaries, and validation. ## Why Coding agents need hard guardrails without duplicating `CONTRIBUTING.md`. ## Test - Oxfmt - `git diff --check` - verified referenced files and targets against current `main`
1 parent 7e7ad15 commit ac80835

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Agent guidance
2+
3+
Follow [CONTRIBUTING.md](./CONTRIBUTING.md) for setup, development, and release
4+
commands.
5+
6+
## Scope
7+
8+
- Treat `src/generated/`, `src/resources.ts`, and `src/resources/` as output
9+
from a private SDK codegen pipeline. Do not edit them.
10+
- Keep handwritten changes focused and preserve unrelated generated files.
11+
- Update `package.json` and `pnpm-lock.yaml` together for dependency changes.
12+
13+
## Workflow
14+
15+
- Use Bazel targets instead of direct Node test or build commands.
16+
- Run `bazel run //:gazelle` after adding files or changing imports.
17+
- Do not bump versions, edit release PR output, or publish packages manually.
18+
19+
## Validation
20+
21+
- Run `bazel test //...`.
22+
- Run `bazel test //:test //:package_checks //e2e:sdk_parity` for public-surface
23+
changes.
24+
- Run `pnpm lefthook run pre-commit --all-files --force --fail-on-changes`.
25+
- Run live tests only when explicitly requested and `PPLX_API_TOKEN` is
26+
available.

0 commit comments

Comments
 (0)