Uh oh!
There was an error while loading. Please reload this page.
docs(agents): note lint/format/typecheck are advisory, not blocking - #2886
Merged
Conversation
Contributor
|
pranaygp
marked this pull request as ready for review
July 21, 2026 05:55
Uh oh!
There was an error while loading. Please reload this page.
github-actionsBot
added a commit
that referenced
this pull request
Jul 21, 2026
…2886) Co-authored-by: Claude <noreply@anthropic.com> Signed-off-by: Pranay Prakash <pranay.gp@gmail.com>
Contributor
Backport PR opened against |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds guidance for agents/contributors clarifying that local lint/format/typecheck runs are helpful but non-blocking, with CI as the enforcement source of truth.
Changes:
- Inserted a new “Local Checks vs. CI” section after “Code Style”.
- Clarified that
pnpm lint,pnpm format, andpnpm typecheckare advisory locally and enforced in CI.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pranaygp added a commit
that referenced
this pull request
Jul 21, 2026
* origin/main: (21 commits) docs(agents): note lint/format/typecheck are advisory, not blocking (#2886) Retry transient connection timeouts (#3013) fix(world-vercel): append caller User-Agent products instead of discarding them (#2998) [ci] Enable NestJS e2e-vercel-prod and add to docs as "experimental" (#3011) [ci] Benchmark comment: Best column + best/p75/p99 deltas (drop Avg/P10) (#3005) docs: fall back to first child page for sidebar folders without an index (#3009) [nest] Fix NestJS Vercel build output (#2988) Avoid resolving run data for background steps (#2993) chore(docs): update @vercel/geistdocs to 1.14.0 (#3002) fix(docs): add version-switcher fallback redirects for pages missing in one version (#3003) ci: update opencode to 1.18.4 and switch backport AI model to claude-fable-5 (#3006) fix(core): batch stream writes via writeMulti (#2995) perf(core): cache port discovery in step invocations for self-hosted worlds (#2996) feat(web-shared): Alt+hover span measurement in the new trace viewer (#2985) fix(world-postgres): throw EntityConflictError on duplicate run_created (#2983) [ci] Run benchmarks in-deployment to avoid proxy overhead (#2967) Enable additional perf optimizations when correctness guarantees are met (#2970) perf(core): prepare replay payloads concurrently (#2980) Fix dotted tsconfig alias workflow discovery (#2963) Adjust helper position on trace viewer (#2968) ...
pranaygp added a commit
that referenced
this pull request
Jul 21, 2026
* origin/main: test: regression coverage for hook.resume() from isolated route bundles (o2flow beta.26 incident) (#3001) docs(agents): note lint/format/typecheck are advisory, not blocking (#2886) Retry transient connection timeouts (#3013) fix(world-vercel): append caller User-Agent products instead of discarding them (#2998) [ci] Enable NestJS e2e-vercel-prod and add to docs as "experimental" (#3011) [ci] Benchmark comment: Best column + best/p75/p99 deltas (drop Avg/P10) (#3005) docs: fall back to first child page for sidebar folders without an index (#3009) [nest] Fix NestJS Vercel build output (#2988) Avoid resolving run data for background steps (#2993) chore(docs): update @vercel/geistdocs to 1.14.0 (#3002) fix(docs): add version-switcher fallback redirects for pages missing in one version (#3003) ci: update opencode to 1.18.4 and switch backport AI model to claude-fable-5 (#3006) fix(core): batch stream writes via writeMulti (#2995)
pranaygp added a commit
that referenced
this pull request
Jul 22, 2026
* origin/main: (162 commits) Implement `max_events` per run limit (#2986) [core] Enforce maxRetries for steps that time out (#3035) [world-vercel] Idempotent retry policy for stream close (5xx retriable) (#3038) [world] Guard hook_received against a concurrent run termination (#2987) docs: fix stale/incorrect v5 API reference details (#3017) Default WORKFLOW_PRECONDITION_GUARD on (#2946) docs: replace migration guides with a Comparisons section (#2676) feat(core): add experimental Hook minimum retention (#2865) test: regression coverage for hook.resume() from isolated route bundles (o2flow beta.26 incident) (#3001) docs(agents): note lint/format/typecheck are advisory, not blocking (#2886) Retry transient connection timeouts (#3013) fix(world-vercel): append caller User-Agent products instead of discarding them (#2998) [ci] Enable NestJS e2e-vercel-prod and add to docs as "experimental" (#3011) [ci] Benchmark comment: Best column + best/p75/p99 deltas (drop Avg/P10) (#3005) docs: fall back to first child page for sidebar folders without an index (#3009) [nest] Fix NestJS Vercel build output (#2988) Avoid resolving run data for background steps (#2993) chore(docs): update @vercel/geistdocs to 1.14.0 (#3002) fix(docs): add version-switcher fallback redirects for pages missing in one version (#3003) ci: update opencode to 1.18.4 and switch backport AI model to claude-fable-5 (#3006) ... # Conflicts: # docs/content/docs/v4/deploying/meta.json # docs/content/docs/v5/deploying/meta.json # packages/core/src/runtime.ts # packages/world-local/src/index.ts # packages/world-postgres/src/index.ts # packages/world/src/events.ts # packages/world/src/interfaces.ts # packages/world/src/recovery.ts # workbench/nest/src/main.ts # workbench/sveltekit/src/hooks.server.ts
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 freeto 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.
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