Skip to content

docs(agents): document lint/format command and correct release:ci steps #131

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

Closed
tembo wants to merge 1 commit into from
Closed

docs(agents): document lint/format command and correct release:ci steps #131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ Changesets create random friendly filenames in `.changeset/`. The filename does

Normal feature PRs do not publish. Changesets accumulate on `main`; the `Version packages` PR is the release button.

## Linting and Formatting

Lint and format with oxlint/oxfmt before opening a PR:

```bash
bun run check
```

That runs `oxlint` then `oxfmt --write`. To lint a single package without formatting, scope oxlint directly, e.g. `bunx oxlint packages/email-sdk/src`.

## Release Checks

Before merging release-sensitive SDK or CLI work, run:
Expand All @@ -35,7 +45,7 @@ Before merging release-sensitive SDK or CLI work, run:
bun run release:ci
```

That runs type checks, tests, build, and npm package dry-run.
That runs type checks, tests, the community registry check (`bun run community:check`), the docs versions check (`bun run docs:versions:check`), build, and the npm package dry-run (`bun run pack:check`).

For a quick local CLI smoke test:

Expand Down