Skip to content

chore: add AGENTS.md and check formatting in CI - #298

Merged
lihbr merged 1 commit into
masterfrom
lh/agents-md
Nov 18, 2026
Merged

lihbr merged 1 commit into
masterfrom
lh/agents-md

Conversation

@lihbr

@lihbr lihbr commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

Before this PR, agents working here had no shared rules, and CI didn't check formatting, so unformatted code could land on master.

After this PR, AGENTS.md holds the same rules as the TypeScript template (prismic-typescript-template#54), with the e2e line adapted to this repo's Playwright setup in tests/infra. A format job runs oxfmt --check next to lint.

CHANGELOG.md is now ignored by oxfmt, like in prismic-svelte and prismic-ts-codegen. It was the only unformatted file, and Release Please rewrites it on each release.

Created with Opus 5.5 in Claude Code.


Note

Low Risk
Documentation, CI, and formatter config only; no application or runtime behavior changes.

Overview
Adds AGENTS.md with shared rules for contributors and agents (minimal diffs, no new runtime deps, Playwright e2e against real Prismic, Conventional Commits / Release Please workflow).

CI validate now runs a parallel format job that installs deps and runs npm run format -- --check (oxfmt) so unformatted code fails on push.

.oxfmtrc.json adds ignorePatterns: ["CHANGELOG.md"] so Release Please–managed changelog formatting is not enforced.

Reviewed by Cursor Bugbot for commit d5329a5. Bugbot is set up for automated code reviews on this repo. Configure here.

@lihbr
lihbr merged commit fdab4ed into master Nov 18, 2026
12 checks passed
@lihbr
lihbr deleted the lh/agents-md branch November 18, 2026 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant