Skip to content

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

Merged
leoisadev1 merged 6 commits into
mainfrom
tembo/agents-md-local-checks
Jul 6, 2026
Merged

docs(agents): document lint/format and adapter account checks#122
leoisadev1 merged 6 commits into
mainfrom
tembo/agents-md-local-checks

Conversation

@tembo

@tembo tembo Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates AGENTS.md to cover two workflows/commands that exist in the repo but were not documented. The file was last touched in #11, and several commands have since landed in package.json/scripts/.

Adds a Local Checks section documenting:

  • Targeted linting with bunx oxlint <path> for touched files, plus an explicit warning that bun run check runs oxfmt --write repo-wide (reformats ~170 drifted files) and that CI does not enforce formatting/linting — so it should not be run casually.
  • Live adapter account checks for verifying a provider adapter against a real account, reading credentials from .env.local:
    • bun run live:sequenzy, bun run live:lettermint (script aliases in package.json)
    • bun scripts/check-jetemail-account.ts, bun scripts/check-primitive-account.ts (adapters without an alias, run directly)

Recent PRs added the Lettermint, Primitive, and JetEmail adapters, each with a scripts/check-*-account.ts helper, so the adapter-verification workflow is now a recurring part of adapter work.

Merge-conflict pre-resolution with #120

This branch edits the same AGENTS.md region as #120 (tembo/update-agents-md-docs-workflows), so tembo/update-agents-md-docs-workflows has been merged into this branch and the overlap resolved: both the Docs Site section (from #120) and the Local Checks section (from this PR) coexist, and the duplicated lint guidance is consolidated into Local Checks with a cross-reference from Release Checks. This PR therefore currently includes #120's commits; once #120 merges, its commits drop out of this PR's diff and only the Local Checks additions plus the lint consolidation remain.

Notes

  • Edits are minimal and grounded in actual package.json scripts and scripts/ files — no invented commands.
  • No unrelated sections were modified; auto-generated files were left untouched.

Triggered by a pull_request.merged workflow event.


Want tembo to make any changes? Add a comment with @tembo and i'll get back to work!

View on Tembo View Agent Settings View on automation

@tembo tembo Bot added the tembo Pull request created by Tembo label Jun 30, 2026
@tembo

tembo Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

Requesting review from @leoisadev1 who has experience with the following files modified in this PR:

  • AGENTS.md

@tembo tembo Bot requested a review from leoisadev1 June 30, 2026 01:51
@vercel

vercel Bot commented Jun 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
email-sdk-fumadocs Ready Ready Preview, Comment Jul 6, 2026 3:36pm

Request Review

…s with oxlint

bun run check runs oxfmt --write, which reformats ~170 drifted files, and CI
does not enforce formatting — so recommend targeted bunx oxlint instead.

Generated-By: PostHog Code
Task-Id: ec2538f2-5c80-4142-b4b3-b1a53394862e
…s with oxlint

bun run check runs oxfmt --write, which reformats ~170 drifted files, and CI
does not enforce formatting — so recommend targeted bunx oxlint instead.

Generated-By: PostHog Code
Task-Id: ec2538f2-5c80-4142-b4b3-b1a53394862e
…s-md-local-checks

Pre-resolves the AGENTS.md overlap with #120: both sections coexist, and the
duplicated lint guidance is consolidated into the Local Checks section with a
cross-reference from Release Checks.

Generated-By: PostHog Code
Task-Id: ec2538f2-5c80-4142-b4b3-b1a53394862e
@leoisadev1 leoisadev1 marked this pull request as ready for review July 6, 2026 15:20
@greptile-apps

greptile-apps Bot commented Jul 6, 2026

Copy link
Copy Markdown

Greptile Summary

This PR updates repository agent guidance for local checks. The main changes are:

  • Moves lint guidance into a new Local Checks section.
  • Documents targeted linting with bunx oxlint <path>.
  • Warns that bun run check reformats the repository.
  • Adds live provider adapter account-check commands.

Confidence Score: 5/5

Documentation-only changes are safe to merge.

The changes are limited to AGENTS.md guidance and introduce no runtime code paths.

T-Rex T-Rex Logs

What T-Rex did

  • The base AGENTS.md file was found to include Release Checks lint guidance and a bun run check warning, but had no Local Checks section or live adapter account command block.
  • The head AGENTS.md was updated to include a Local Checks section (lines 50–71) documenting bunx oxlint <path>, warning that bun run check executes oxfmt --write, stating that CI does not enforce formatting or linting, and listing the live aliases and the related script checks.
  • Package and script evidence confirms that check is oxlint && oxfmt --write, both live aliases exist, both direct script files exist, alias targets exist, and all checked scripts load .env.local, while the workflow grep shows no enforcement of bun run check, oxlint, or oxfmt in CI/Depot workflow files.
  • The CI/Depot workflow evidence shows there is no enforcement of bun run check, oxlint, or oxfmt, supporting the intended development workflow described in the Local Checks guidance.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (2): Last reviewed commit: "merge main after #120 squash; keep conso..." | Re-trigger Greptile

@tembo

tembo Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Greptile Summary

This PR updates repository agent guidance for local checks, release checks, and docs workflows. The main changes are:

  • Adds targeted lint guidance with bunx oxlint <path>.
  • Documents why bun run check should not be run casually.
  • Adds live provider adapter account check commands.
  • Expands release check details for registry and docs validation.
  • Adds docs site development, build, blog, and environment notes.

Confidence Score: 5/5

Safe to merge as documentation-only guidance changes.

The changes are limited to AGENTS.md and document existing commands and workflows without modifying runtime code.

T-Rex T-Rex Logs

What T-Rex did

  • Compared the before and after local checks lint setup and confirmed the head adds bunx oxlint <path> and that the root check script runs oxlint and oxfmt --write.
  • Verified the adapter-account-checks after state shows Local Checks guidance and that the referenced aliases/files exist; live provider scripts were not executed because the validation focused on documentation accuracy.
  • Validated the head now contains Release Checks, Local Checks, and Docs Site with all three booleans True, and the cross-references appear at lines 41 (Release Checks), 50 (Local Checks), and 79 (Docs Site); both transcripts exited with code 0.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "Merge branch 'tembo/update-agents-md-doc..." | Re-trigger Greptile

the greptile review on pr #122 is a 5/5 approval ("safe to merge") with no requested changes, so there was nothing to fix.

what i did do was re-sync the branch (it had picked up the parallel tembo/update-agents-md-docs-workflows commits via a merge) and re-verify every documented command against the actual repo:

  • docs siteapps/fumadocs dev runs on port 4000, bun run build fetches notra posts then runs vite build, posts:fetch and src/lib/notra-runtime.ts exist, and the blog routes really are excluded from prerender in vite.config.ts. all accurate.
  • "ci does not enforce formatting or linting" — accurate; .depot/workflows/ci.yml only runs bun run release:ci, which has no oxlint/oxfmt step.
  • bun run check reformats repo-wide — accurate; package.json check = oxlint && oxfmt --write.
  • local checks + adapter account scripts — the live:* aliases and scripts/check-*-account.ts files all exist.

the merged result reads cleanly with no duplicated sections despite the two similar lint commits.

one honesty note: i did not re-run a repo-wide format to confirm the exact "roughly 170 files" figure — that would need a full bun install + format pass, and the number is hedged and non-load-bearing. everything else is grounded in repo usage.

nothing to change — the pr is accurate and ready to merge.

Generated-By: PostHog Code
Task-Id: ec2538f2-5c80-4142-b4b3-b1a53394862e
@leoisadev1 leoisadev1 merged commit f0d78c1 into main Jul 6, 2026
4 checks passed
@leoisadev1 leoisadev1 deleted the tembo/agents-md-local-checks branch July 6, 2026 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant