-
Notifications
You must be signed in to change notification settings - Fork 4.2k
GH-48951: [Docs] Add documentation relating to AI tooling #48952
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
Changes from 4 commits
7641f2f
e10fb80
813ef6c
3869b14
8978acf
ad0bc89
55a02bc
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 |
|---|---|---|
|
|
@@ -146,6 +146,43 @@ will merge the pull request. This is done with a | |
| description, a link back to the pull request, and attribution to the contributor | ||
| and any co-authors. | ||
|
|
||
| .. _ai-generated-code: | ||
|
|
||
| AI-generated code | ||
| +++++++++++++++++ | ||
|
|
||
| We recognise that AI coding assistants are now a regular part of many | ||
| developers' workflows and can improve productivity. Thoughtful use of these | ||
| tools can be beneficial, but AI-generated PRs can sometimes lead to | ||
| undesirable additional maintainer burden. PRs that appear to be fully | ||
| generated by AI with little to no engagement from the author may be closed | ||
| without further review. | ||
|
|
||
| Human-generated mistakes tend to be easier to spot and reason about, and | ||
| code review often feels like a collaborative learning experience that | ||
| benefits both submitter and reviewer. When a PR appears to have been | ||
| generated without much engagement from the submitter, reviewers with access | ||
| to AI tools could more efficiently generate the code directly. | ||
|
thisisnic marked this conversation as resolved.
Outdated
|
||
|
|
||
| We are not opposed to the use of AI tools in generating PRs, but recommend | ||
| the following: | ||
|
|
||
| * Only take on a PR if you are able to debug and own the changes yourself - | ||
|
thisisnic marked this conversation as resolved.
Outdated
thisisnic marked this conversation as resolved.
Outdated
|
||
| review all generated code to understand every detail | ||
| * Match the style and conventions used in the rest of the codebase, including | ||
| PR titles and descriptions | ||
| * Be upfront about AI usage and summarise what was AI-generated | ||
| * If there are parts you don't fully understand, leave comments on your own PR | ||
| explaining what steps you took to verify correctness | ||
| * Watch for AI's tendency to generate overly verbose comments, unnecessary | ||
| test cases, and incorrect fixes | ||
| * Break down large PRs into smaller ones to make review easier | ||
|
|
||
| PR authors are also responsible for disclosing any copyrighted materials in | ||
| submitted contributions. See the `ASF's guidance on AI-generated code | ||
|
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. Do we need to modify the PR template about this?
Member
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. I think we're good, as we already have a link to this page in the template already, and it covers quite a few other topics too. |
||
| <https://www.apache.org/legal/generative-tooling.html>`_ for further | ||
| information on licensing considerations. | ||
|
|
||
| .. Section on Experimental repositories: | ||
|
|
||
| .. include:: experimental_repos.rst | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.