Skip to content

Commit afbfe11

Browse files
committed
Add AI guidelines to contributing guide
1 parent 8518419 commit afbfe11

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Here are some ways to contribute to the project, from easiest to most difficult:
2121
- [Building](#building)
2222
- [Testing](#testing)
2323
- [Wiring a checkout into an application](#wiring-a-checkout-into-an-application)
24+
- [AI contribution guidelines](#ai-contribution-guidelines)
2425

2526
## Issues
2627

@@ -202,3 +203,18 @@ echo "console.log('it worked');" >> index.ts
202203
```
203204

204205
Visit http://localhost:3000/ and open your browsers dev console. After the Apollo Client rebuild finishes, you should see `it worked` in the console.
206+
207+
## AI contribution guidelines
208+
209+
We understand that more and more code is written by AI-assisted coding tools and as such, it is easier than ever to contribute to Apollo Client in the form of issues and PRs. Triaging issues and reviewing AI-assisted PRs tend to take up more maintainer bandwidth than traditional contributions and can take away opportunities for advancement in other areas of the library.
210+
211+
While we recognize the value of AI tools, we ask that you use AI responsibly:
212+
213+
- Always review AI-generated code yourself before submitting a PR.
214+
- 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.
215+
- 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.
216+
- 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.
217+
- Do not open issues or PRs generated by AI tools that provide solutions in search of a problem. Issues need to have a clear end-to-end reproduction with a problem experienced in a production environment with relevant context on what caused the problem to appear. This gives the maintainers a chance to provide feedback so that a PR solves the right problem.
218+
- Let the maintainers know you are interested in contributing a PR to fix an issue by adding a comment in the issue. This avoids PR overlap from different contributors.
219+
220+
Pull requests and issues that ignore these guidelines might be closed at the maintainers' discretion.

0 commit comments

Comments
 (0)