docs: add generative ai contribution guidelines #19427
Conversation
03c53fd to
985bb3b
Compare
There was a problem hiding this comment.
Great start @Emyrk, thanks! A few minor points, appreciate your putting this together
|
|
||
| ## Disclosure | ||
|
|
||
| Contributors must **disclose AI involvement** in the pull request description whenever these guidelines apply. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
I'm not 100% sure. I know we can make issue templates, never tried for PRs
There was a problem hiding this comment.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@Emyrk can we please include this? Right now folks won't know to look at your new doc; let's increase discoverability.
Co-authored-by: Danny Kopping <danny@coder.com>
| @@ -0,0 +1,32 @@ | |||
| # Guidelines for Using Generative AI in Contributions | |||
|
|
|||
| 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). | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Short and clear, I think this is a good starting point 👍🏻. I feel this guide is mostly for humans, would it make sense to have one targeting AI's as well? Or alternatively, having a hidden section act as clear instructions for the AI. Either way, that can come later.
|
|
||
| ## Disclosure | ||
|
|
||
| Contributors must **disclose AI involvement** in the pull request description whenever these guidelines apply. |
There was a problem hiding this comment.
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.
Co-authored-by: Cian Johnston <cian@coder.com>
Co-authored-by: Cian Johnston <cian@coder.com>
Very interesting idea |
Initial language that gives us something to point to if needed.
I did not include language around the size of a PR. I think we should have normal contribution guidelines about very large PRs, include tests, etc, etc.