Repository navigation
chore: add AGENTS.md and check formatting in CI - #298
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdholds the same rules as the TypeScript template (prismic-typescript-template#54), with the e2e line adapted to this repo's Playwright setup intests/infra. Aformatjob runsoxfmt --checknext tolint.CHANGELOG.mdis 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.mdwith shared rules for contributors and agents (minimal diffs, no new runtime deps, Playwright e2e against real Prismic, Conventional Commits / Release Please workflow).CI
validatenow runs a parallelformatjob that installs deps and runsnpm run format -- --check(oxfmt) so unformatted code fails on push..oxfmtrc.jsonaddsignorePatterns: ["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.