docs(agents): note lint/format/typecheck are advisory, not blocking#2886
Draft
pranaygp wants to merge 1 commit into
Draft
docs(agents): note lint/format/typecheck are advisory, not blocking#2886pranaygp wants to merge 1 commit into
pranaygp wants to merge 1 commit into
Conversation
Contributor
|
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
2 participants
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.
Description
Adds a new "Local Checks vs. CI" section to
AGENTS.md(whichCLAUDE.mdsymlinks to). It clarifies that linting, formatting, and typechecking (pnpm lint,pnpm format,pnpm typecheck) are all facets of a single, advisory static-quality gate. Agents should run them and fix obvious issues when convenient, but a failure in any of them should not block committing, pushing, or opening a PR — CI enforces them on every PR and is the source of truth.The section is inserted immediately after
## Code Styleand before## Documentation Standards. No other files are changed.Slack thread: https://vercel.slack.com/archives/C09G3EQAL84/p1783842727323939?thread_ts=1783790478.067249&cid=C09G3EQAL84
How did you test your changes?
Documentation-only change to a root markdown file; no code paths affected. Verified the new section is placed exactly between the
## Code Styleand## Documentation Standardssections.PR Checklist - Required to merge
pnpm changesetwas run to create a changelog for this PRAGENTS.md) that touches no package, so no changeset is needed.git commit --signoffon your commits)@vercel/workflowin a comment once the PR is ready, and the above checklist is complete🤖 Generated with Claude Code
Generated by Claude Code