Skip to content

docs: add generative ai contribution guidelines #19427

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.

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

Merged
merged 9 commits into from
Aug 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions docs/about/contributing/AI_CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AI Contribution Guidelines

This document defines rules for contributions where an AI system is the primary author of the code (i.e., most of the pull request was generated by AI).
Copy link
Member

Choose a reason for hiding this comment

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

most of the pull request was generated by AI)

This decision is very much "vibes based" from the reviewer's perspective. As such, I anticipate that this may be the source of a number of arguments. Unfortunately, I don't have any suggestion for a better delineation.

Copy link
Member Author

Choose a reason for hiding this comment

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

I do agree, but I kept it subjective because I know we all use AI day to day in our coding. I did not want to encompass our usual PRs.

I do not like the idea of saying like "50% of lines" or something.

It applies to all Coder repositories and is a supplement to the [existing contributing guidelines](./CONTRIBUTING.md), not a replacement.

For minor AI-assisted edits, suggestions, or completions where the human contributor is clearly the primary author, these rules do not apply — standard contributing guidelines are sufficient.

## Disclosure

Contributors must **disclose AI involvement** in the pull request description whenever these guidelines apply.
Copy link
Contributor

Choose a reason for hiding this comment

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

We should pair this with a PULL_REQUEST_TEMPLATE.md file to elicit this disclosure and link to this page. I'm not sure many folks will find this doc organically. I don't think we can customize the links under the PR description box, can we?

Image

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not 100% sure. I know we can make issue templates, never tried for PRs

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

It'd be nice to have a standard way to represent AI contributors. We could either have a separate AI PR template or put the AI splash in the template inside <!-- / --> so it can be surfaced with relative ease. In the past we had a PR template and it was a bit of an inconvenience IIRC, hopefully that has improved.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Emyrk can we please include this? Right now folks won't know to look at your new doc; let's increase discoverability.


## Human Ownership & Attribution

- All pull requests must be opened under **user accounts linked to a human**, and not an application ("bot account").
- Contributors are personally accountable for the content of their PRs, regardless of how it was generated.

## Verification & Evidence

All AI-assisted contributions require **manual verification**.
Contributions without verification evidence will be rejected.

- Test your changes yourself. Don’t assume AI is correct.
- Provide screenshots showing that the change works as intended.
- For visual/UI changes: include before/after screenshots.
- For CLI or backend changes: include terminal or api output.

## Why These Rules Exist

Traditionally, maintainers assumed that producing a pull request required more effort than reviewing it.
With AI-assisted tools, the balance has shifted: generating code is often faster than reviewing it.

Our guidelines exist to safeguard maintainers’ time, uphold contributor accountability, and preserve the overall quality of the project.
5 changes: 5 additions & 0 deletions docs/about/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,11 @@ Breaking changes can be triggered in two ways:
[`release/breaking`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Arelease%2Fbreaking)
label to a PR that has, or will be, merged into `main`.

### Generative AI

Using AI to help with contributions is acceptable, but only if the [AI Contribution Guidelines](./AI_CONTRIBUTING.md)
are followed. If most of your PR was generated by AI, please read and comply with these rules before submitting.

### Security

> [!CAUTION]
Expand Down
1 change: 1 addition & 0 deletions docs/images/icons/ai_intelligence.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@
"description": "Security vulnerability disclosure policy",
"path": "./about/contributing/SECURITY.md",
"icon_path": "./images/icons/lock.svg"
},
{
"title": "AI Contribution Guidelines",
"description": "Guidelines for AI-generated contributions.",
"path": "./about/contributing/AI_CONTRIBUTING.md",
"icon_path": "./images/icons/ai_intelligence.svg"
}
]
}
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy