Add AI contribution guidelines by jerelmiller · Pull Request #13369 · apollographql/apollo-client

jerelmiller · 2026-07-29T22:50:12Z

We are starting to get more and more contributions that use AI tools. This PR adds a section in our contribution guide on the use of AI tools so that we have something to reference.

Summary by CodeRabbit

Documentation
- Added guidelines for contributing AI-generated code and content.
- Clarified expectations for review, context, reproducible issues, coordination, and compliance.

apollo-librarian · 2026-07-29T22:50:16Z

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 9fdb68c9e8077bd96f444a2b
Build Logs: View logs

✅ AI Style Review — No Changes Detected

No MDX files were changed in this pull request.

Review Log: View detailed log

This review is AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

changeset-bot · 2026-07-29T22:50:16Z

⚠️ No Changeset found

Latest commit: 9d9f032

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 · 2026-07-29T22:50:46Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 6f75d33e-9654-4be6-bb2a-d53dcf0d194f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Walkthrough

Walkthrough

CONTRIBUTING.md adds an AI contribution guidelines entry to its table of contents and introduces contributor expectations covering review, context, coordination, and potential closure for noncompliance.

Changes

AI contribution guidelines

Layer / File(s)	Summary
Add AI contribution guidance `CONTRIBUTING.md`	Adds a table-of-contents link and a section describing expectations for reviewing and submitting AI-assisted contributions.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: benjamn

Poem

I’m a rabbit with guidelines bright,
Helping AI contributions hop right.
Review with care, add context too,
Coordinate kindly in all you do.
Clear paths make the carrots grow!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely matches the main change: adding AI contribution guidelines to the contributing guide.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

_{Comment @coderabbitai help to get the list of available commands.}

pkg-pr-new · 2026-07-29T22:51:54Z

npm i https://pkg.pr.new/@apollo/client@13369

commit: 9d9f032

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 214: Update the contributor guidance sentence to use the correctly
hyphenated term “follow-up” instead of “followup,” without changing the rest of
the sentence.
- Line 215: Update the contribution guidance around “Do not ignore the issue
templates” so opening an issue first is required only for substantial or unclear
changes, not every PR. Preserve the existing exceptions and direct-PR guidance
for documentation improvements and small bug fixes, while keeping the big-PR
workflow’s issue-first requirement.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 220e329b-f57e-43a4-a750-495e0fa1e3b4

📥 Commits

Reviewing files that changed from the base of the PR and between 8518419 and 17ff642.

📒 Files selected for processing (1)

CONTRIBUTING.md

phryneas · 2026-07-30T07:32:43Z

  - [Building](#building)
  - [Testing](#testing)
  - [Wiring a checkout into an application](#wiring-a-checkout-into-an-application)
+- [AI contribution guidelines](#ai-contribution-guidelines)


We should also add a link to this in the PR templates.

phryneas · 2026-07-30T07:44:00Z

+- Always review AI-generated code yourself before submitting a PR.
+- Only open issues and PRs that you understand yourself. The maintainers tend to ask follow-up questions about the issue or design choices in a PR and you need to be able to explain them.
+- Do not ignore the issue templates. Open an issue first to discuss solutions with the maintainers before opening PRs to reach agreement on how best to fix. The maintainers often have additional context about the code that might be relevant to the problem.
+- Avoid AI-generated content in comments, especially in response to questions and feedback posted by the maintainers. LLMs tend to take maintainer feedback verbatim and make changes without additional discussion. This adds a lot of churn and maintainers' time to constantly re-review changes that might not adequately address the feedback.


Please also avoid using AI to rephrase your comments unless absolutely necessary. We much rather talk to someone in non-perfect English than talking to them through a machine without knowing someone is there at the other end.

Probably there's a better way to say this, but the important part here is "I'd rather talk to someone in broken English than to Claude impersonating someone".

Good call. I tacked on part of that to the end of this sentence: e376078

jerelmiller · 2026-07-30T20:29:52Z

I think this is solid for now. We can always revisit and revise as needed.

coderabbitai Bot reviewed Jul 29, 2026

View reviewed changes

Comment thread CONTRIBUTING.md Outdated

Comment thread CONTRIBUTING.md

Add AI guidelines to contributing guide

afbfe11

jerelmiller force-pushed the jerel/contribution-guidelines branch from 17ff642 to afbfe11 Compare July 29, 2026 23:10

phryneas reviewed Jul 30, 2026

View reviewed changes

jerelmiller added 3 commits July 30, 2026 14:26

Add link in PR template

0563961

Update sentence

e376078

Merge branch 'main' into jerel/contribution-guidelines

9d9f032

jerelmiller enabled auto-merge (squash) July 30, 2026 20:29

jerelmiller merged commit db42896 into main Jul 30, 2026
50 checks passed

jerelmiller deleted the jerel/contribution-guidelines branch July 30, 2026 21:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add AI contribution guidelines - #13369

Add AI contribution guidelines#13369
jerelmiller merged 4 commits into
mainfrom
jerel/contribution-guidelines

jerelmiller commented Jul 29, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

apollo-librarian Bot commented Jul 29, 2026 •

edited

Loading

Uh oh!

changeset-bot Bot commented Jul 29, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 29, 2026 •

edited

Loading

Review skipped

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Jul 29, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

phryneas Jul 30, 2026

Uh oh!

phryneas Jul 30, 2026 •

edited

Loading

Uh oh!

jerelmiller Jul 30, 2026

Uh oh!

jerelmiller commented Jul 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

jerelmiller commented Jul 29, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

apollo-librarian Bot commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview has no changes

✅ AI Style Review — No Changes Detected

Uh oh!

changeset-bot Bot commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai Bot commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

phryneas Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

phryneas Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jerelmiller Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

jerelmiller commented Jul 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jerelmiller commented Jul 29, 2026 •

edited by coderabbitai Bot

Loading

apollo-librarian Bot commented Jul 29, 2026 •

edited

Loading

changeset-bot Bot commented Jul 29, 2026 •

edited

Loading

coderabbitai Bot commented Jul 29, 2026 •

edited

Loading

pkg-pr-new Bot commented Jul 29, 2026 •

edited

Loading

phryneas Jul 30, 2026 •

edited

Loading