Skip to content

docs: expand agent contribution guidance - #12586

Merged
TkDodo merged 1 commit into
mainfrom
tkdodo/improve-agent-contributor-guidance
Nov 12, 2026
Merged

TkDodo merged 1 commit into
mainfrom
tkdodo/improve-agent-contributor-guidance

Conversation

@TkDodo

@TkDodo TkDodo commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

🎯 Changes

Expand AGENTS.md with shared contribution guidance for agents. Cover problem validation, focused changes, regression proof, bundle cost, related adapters, and documentation. Keep the rules general and link to the existing contribution requirements.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

Validation: git diff --check passed, and all local Markdown links resolve. Runtime tests do not apply to this documentation-only change. The formatter is unavailable because worktree dependencies are not installed.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Expanded contributor guidance with sections on defining problems, making focused corrections, documenting regression evidence, considering bundle size and related adapters, and reporting changes.
    • Added a reference to the AI policy and guidance to verify and describe contributions.

@changeset-bot

changeset-bot Bot commented Nov 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8896422

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

Caution

Review failed

The pull request is closed.

Walkthrough

AGENTS.md expands contributor guidance to cover problem analysis, corrections, regression testing, runtime and bundle costs, related adapters, documentation, and change reporting.

Changes: Contribution guidance

Layer / File(s) Summary
Problem analysis and correction
AGENTS.md
The guidance adds instructions for identifying observable failures, checking existing support and fixes, tracing causes, preserving compatibility, and verifying corrections with regression tests.
Additional review and reporting checks
AGENTS.md
The guidance adds checks for runtime and bundle costs, related adapters, public API documentation, changesets, and verification reports.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Suggested reviewers: kevinvandy, lachlancollins

Merge Risk: Minimal · up to 88964

This change expands contributor guidance in AGENTS.md only and does not alter runtime behavior. No actionable merge-blocking risk remains.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@nx-cloud

nx-cloud Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 8896422

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 2m 20s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-11-12 09:10:01 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@TkDodo
TkDodo merged commit 10123d9 into main Nov 12, 2026
7 of 8 checks passed
@TkDodo
TkDodo deleted the tkdodo/improve-agent-contributor-guidance branch November 12, 2026 09:08
@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.85 KB (0%)
react minimal 8.67 KB (0%)

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