docs(agents): document lint/format and adapter account checks#122
Conversation
|
Requesting review from @leoisadev1 who has experience with the following files modified in this PR:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…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
Greptile SummaryThis PR updates repository agent guidance for local checks. The main changes are:
Confidence Score: 5/5Documentation-only changes are safe to merge. The changes are limited to AGENTS.md guidance and introduce no runtime code paths.
What T-Rex did
Reviews (2): Last reviewed commit: "merge main after #120 squash; keep conso..." | 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
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 nothing to change — the pr is accurate and ready to merge. |
Generated-By: PostHog Code Task-Id: ec2538f2-5c80-4142-b4b3-b1a53394862e
Summary
Updates
AGENTS.mdto 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 inpackage.json/scripts/.Adds a Local Checks section documenting:
bunx oxlint <path>for touched files, plus an explicit warning thatbun run checkrunsoxfmt --writerepo-wide (reformats ~170 drifted files) and that CI does not enforce formatting/linting — so it should not be run casually..env.local:bun run live:sequenzy,bun run live:lettermint(script aliases inpackage.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.tshelper, 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.mdregion as #120 (tembo/update-agents-md-docs-workflows), sotembo/update-agents-md-docs-workflowshas 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
package.jsonscripts andscripts/files — no invented commands.Triggered by a
pull_request.mergedworkflow event.