Skip to content

docs(agents): document lint/format and adapter account checks #122

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
leoisadev1 merged 6 commits into from
Jul 6, 2026
Merged

docs(agents): document lint/format and adapter account checks #122

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
76bd6eb
docs(agents): document docs-site blog SSR workflow and lint command
Jun 28, 2026
d0106d4
docs(agents): document lint/format and adapter account checks
tembo[bot] Jun 30, 2026
84765e8
docs(agents): warn against repo-wide bun run check; lint touched path…
leoisadev1 Jul 6, 2026
82ff136
docs(agents): warn against repo-wide bun run check; lint touched path…
leoisadev1 Jul 6, 2026
539011a
Merge branch 'tembo/update-agents-md-docs-workflows' into tembo/agent…
leoisadev1 Jul 6, 2026
bbac243
merge main after #120 squash; keep consolidated lint guidance
leoisadev1 Jul 6, 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
22 changes: 18 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,18 @@ bun run release:ci
That runs type checks, tests, community registry + docs version validation,
build, and npm package dry-run.

For linting, lint only the files you touched:
Lint guidance lives in [Local Checks](#local-checks) below.

For a quick local CLI smoke test:

```bash
bun run build
packages/email-sdk/dist/cli.js adapters
```

## Local Checks

Lint the files you touched before committing:

```bash
bunx oxlint <path>
Expand All @@ -49,11 +60,14 @@ repo, which reformats roughly 170 files that have drifted from the formatter.
CI does not enforce formatting or linting, so a repo-wide reformat only adds
noise to your diff.

For a quick local CLI smoke test:
When adding or changing a provider adapter, verify it against a live account. These scripts read provider credentials from `.env.local`:

```bash
bun run build
packages/email-sdk/dist/cli.js adapters
bun run live:sequenzy
bun run live:lettermint
# Adapters without a script alias run directly:
bun scripts/check-jetemail-account.ts
bun scripts/check-primitive-account.ts
```

## Major Versions
Expand Down