Skip to content

docs: document expectations around AI use #11836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kirkwaiblinger wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −0
Open

docs: document expectations around AI use #11836

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e1a518
docs: document expectations around AI use
kirkwaiblinger Dec 10, 2025
6deb5e3
pr feedback
kirkwaiblinger Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/contributing/Pull_Requests.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,28 @@ Please don't:
- Comment on a closed PR
- Reasoning: It is much easier for maintainers to not lose track of things if they are posted as issues. If you think there's a bug in typescript-eslint, the right way to ask is to [file a new issue](https://github.com/typescript-eslint/typescript-eslint/issues/new/choose). The issue templates include helpful & necessary practices such as making sure you're on the latest version of all our packages. You can provide the link to the relevant PR to add more context.

:::warning Contribution standards in the era of AI
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have some way to # link to this - maybe either a heading or a hidden <div id="..." />? I'd bet we're going to want to link to it more and more. 🙃

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going even further than the id point: this is pretty buried in the PRs page. It's not very discoverable. What do you think about making this a sub-page under Pull Requests altogether? Like, /contributing/pull-requests/ai-contributions?

I like the sub-page approach because:

  • It provides a single, central, quick resource we can link to
    • If we want to enourage people to read the full docs, we can always explicitly say "and also please read (insert docs link)"
  • By being a standalone page, we have more flexibility in putting more in it


We reserve the right to close PRs and issues that we deem to be poor quality and/or which we deem will take an undue amount of maintainer effort to make progress on.
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is kind of already implied by us being maintainers, no? I don't think we need to take up space for it. Or I don't think it needs to come first - at the most I think it's relevant as a conclusion from what follows.

Suggested change
We reserve the right to close PRs and issues that we deem to be poor quality and/or which we deem will take an undue amount of maintainer effort to make progress on.


With the rise of AI-assisted coding tools, it has become trivial to generate large amounts of low-quality contributions, for PRs and issues.
Parsing, reviewing, and iterating on these in good faith takes up much more maintainer bandwidth than traditional contributions, taking away bandwidth from other opportunities to advance typescript-eslint.

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 before submitting a PR
- Only use AI to assist in 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
Copy link
Member

@bradzacher bradzacher Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@kirkwaiblinger kirkwaiblinger Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorporated this

- Especially avoid AI-generated PR descriptions.
These tend to just be nearly-verbatim descriptions of the code diff, which add no value to the PR.
Instead, we ask that you summarize the PR succinctly in your own words, relying on your own understanding of the code.

Don't let this dissuade you from contributing to typescript-eslint!
We very much welcome new contributors and are happy to help them improve.
We just are not happy to spend our time working with a contributor who primarily defers to an AI coding assistant; at that point it'd be a better use of our time to prompt the LLM ourselves.

:::

## Testing Changes

### Code Coverage
Expand Down
Loading