docs: document expectations around AI use #11836
Conversation
|
Thanks for the PR, @kirkwaiblinger! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
View your CI Pipeline Execution ↗ for commit 8e1a518
☁️ Nx Cloud last updated this comment at |
|
|
||
| While we cannot and will not attempt to ban contributions which make use of AI, we ask that you use AI responsibly: | ||
|
|
||
| - Always review AI-generated content closely |
There was a problem hiding this comment.
For me this is little vague does this mean the person who send the PR or reviewer. I guess kinda both.
Could this section be written even more cleaner, while stressing that before opening a PR make sure you have reviewed the code yourself, and that you can understand what it does and why. I fear that using language like “to champion” is not easiest to understand for people who are most likely to offend it.
Generally I think this is good addition and doesn’t sound too negative but keeps the welcoming spirit that this project has :)
There was a problem hiding this comment.
I'd also suggest adding this:
| - Always review AI-generated content closely | |
| - Always review AI-generated content closely **_before submitting a PR._** |
To emphasise that we don't want people to vibe a change, ping us with a PR creation and then review it later.
| - Only use AI for contributions that you would understand well enough to champion and respond to feedback on without making use of AI | ||
| - Do not ignore our issue and PR templates | ||
|
|
||
| Don't let this dissuade you from contributing to typescript-eslint! We are generally more than happy to assist new contributors and help them improve at our repo. We just are not interested in babysitting anyone's LLM instances. |
There was a problem hiding this comment.
Instead of saying babysitting, could it this address the problem I have seen, where the person opening PR is acting agent between reviewer and the LLM? “We are capable of running LLMs ourselves and we are not interested in prompting them via PR reviews”?
There was a problem hiding this comment.
Good call out yeah.
If the persons entire role in the process is agentic middleman then we ask that they remove themselves from the process entirely and just not submit the PR.
We can talk to the agent without them as a go-between.
|
|
||
| - Always review AI-generated content closely | ||
| - Only use AI for contributions that you would understand well enough to champion and respond to feedback on without making use of AI | ||
| - Do not ignore our issue and PR templates |
There was a problem hiding this comment.
Possible addition (or some variation of)
Avoid AI generated PR descriptions as they are usually just a verbatim summary of the code.
We require that you summarise your PR changes yourself in your own words. If you cannot summarise your change then you do not understand your change and should not be raising the PR.
3 participants
PR Checklist
Overview
I've just put up an initial message; iteration and criticism is very much invited!
@typescript-eslint/triage-team