-
Notifications
You must be signed in to change notification settings - Fork 5.3k
add a policy on AI usage #8682
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
base: master
Are you sure you want to change the base?
add a policy on AI usage #8682
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -37,6 +37,7 @@ It should serve as a reference for all contributors, and be useful especially to | |||||||
| - [Trivial Edits](#trivial-edits) | ||||||||
| - [Large or Automatic Edits](#large-or-automatic-edits) | ||||||||
| - [Fixing Linter Issues](#fixing-linter-issues) | ||||||||
| - [AI Guidance](#ai-guidance) | ||||||||
| - [The Testing and Merge Workflow](#the-testing-and-merge-workflow) | ||||||||
| - [More About `Ok-To-Test`](#more-about-ok-to-test) | ||||||||
|
|
||||||||
|
|
@@ -599,16 +600,16 @@ at once to that file. | |||||||
|
|
||||||||
| ## Large or Automatic Edits | ||||||||
|
|
||||||||
| Some tools make it very easy to create large Pull Requests, for example: | ||||||||
| Some tools make it very easy to create large and/or automatic Pull Requests, for example: | ||||||||
| - global search/replace | ||||||||
| - linters which automatically correct issues (see also next section) | ||||||||
| - large language models (LLMs) which generate code or documentation | ||||||||
| - AI tools (large language models, assistants, etc) which generate code or documentation | ||||||||
|
|
||||||||
| To make it easier for reviewers to handle such Pull Requests, please explain | ||||||||
| how it was generated in the "Special notes for your reviewer" section of the | ||||||||
| Pull Request description. Reviewers may then be able to reproduce those steps | ||||||||
| (search/replace, linters) or can start the review with the right expectations | ||||||||
| (LLMs). Also consider the section about [splitting up Pull | ||||||||
| (AI tools). Also consider the section about [splitting up Pull | ||||||||
| Requests](#dont-open-pull-requests-that-span-the-whole-repository) above. | ||||||||
|
|
||||||||
| Even with such tools it is still your responsibility as submitter of a Pull | ||||||||
|
|
@@ -622,6 +623,16 @@ reference to this documentation if they come to the conclusion that the | |||||||
| difficulty of properly reviewing the Pull Request outweighs the benefit that | ||||||||
| the Pull Request provides. | ||||||||
|
|
||||||||
| ## AI Guidance | ||||||||
kannon92 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
|
|
||||||||
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. | ||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we should more explicitly call out the expectation to not submit You're not just responsible for understanding the change, but more explicitly for having reviewed the generated output so as not to put the first pass on maintainers to review. Rough sugestion:
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good idea. I just modified this to say reviewers. We should encourage first review by author in place of anyone reviewing the code. Not just the maintainers. |
||||||||
| Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. | ||||||||
| Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. | ||||||||
| When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. | ||||||||
kannon92 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
| If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. | ||||||||
| All contributions must follow the [contributions policies](/contributors/guide/contributing.md) and use commit messages that align with [the policy](#commit-message-guidelines). | ||||||||
| [Large AI generated](#large-or-automatic-edits) PRs and AI generated commit messages are discouraged. | ||||||||
|
|
||||||||
| ## Fixing Linter Issues | ||||||||
|
|
||||||||
| Kubernetes has a set of linter checks. Some of those must pass in the entire | ||||||||
|
|
||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we should also include "LLM" keyword somewhere still for searching?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer AI as LLM is the recent technology but I'm sure there will be new types of AI models that may not be LLMs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm just wondering if we should toss "LLM" once in here somewhere so it greps in addition to what we have now.
Minor point regardless, not a blocking thread.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to resolve this thread as-is.