Skip to content

Commit 369c278

Browse files
committed
First pass at AI guidelines
1 parent 8518419 commit 369c278

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 these days 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 encourage you to make use of AI tools to help make your work as efficient as possible, we ask that you use AI responsibly:
212+
213+
- Always review AI-generated code before submitting a PR.
214+
- Only open issues and PRs that you understand yourself. The maintainers tend to ask followup questions about design decisions and you need to be able to understand and defend your choices.
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 add a lot of churn to PRs because they take maintainer feedback verbatim without more thought or discussion. This takes a lot of the maintainers' time to constantly re-review.
217+
- Do not open drive-by issues created by AI tools. It is ok to use AI tools to explain the technical reasons behind an issue, but there needs to be clear context around why the issue is happening along with a reproduction of the problem.
218+
- Do not open drive-by PRs created by AI tools. These are often too narrowly focused and/or they solve the wrong problem. Solutions should be discussed in an issue before-hand.
219+
220+
Pull requests and issues that ignore these guidelines might be closed at the maintainers' discretion.

0 commit comments

Comments
 (0)