-
-
Notifications
You must be signed in to change notification settings - Fork 994
Update guidelines on using GenAI #1778
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
+67
−42
Merged
Changes from 6 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
726ec3c
Update guidelines on using GenAI
Mariatta e71105b
Update getting-started/generative-ai.rst
Mariatta f8ab6ab
Update the title to clarify the purpose of this doc is to provide gui…
Mariatta a04cd52
Fix the markup in rendering the table
Mariatta ef31ff8
Soften the wording about AI tool disclosure.
Mariatta ff94cd6
Moved the considerations to be earlier in the page.
Mariatta c827f75
Apply suggestions from code review
Mariatta 0406315
Update based on comments.
Mariatta 4092cf2
remove extra header lines
Mariatta 84f3cbd
Add more explicit in the beginning that the person submitting issue o…
Mariatta 6130994
Merge branch 'main' into update-ai-contrib-guide
Mariatta 2aad560
adjust wording about being disrespectful and about reviewing the outp…
Mariatta 52757df
Rename the file to ai-tools.rst
Mariatta cc0ff01
Reformat to 80 chars max
Mariatta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,31 @@ | ||
| .. _generative-ai: | ||
|
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. Please also retain this reference in the new page.
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. |
||
|
|
||
| ============= | ||
| Generative AI | ||
| ============= | ||
| ================================= | ||
| Guidelines in using Generative AI | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
| ================================= | ||
|
gpshead marked this conversation as resolved.
Outdated
|
||
|
|
||
| Generative AI tools have evolved rapidly, and their suggested results can be helpful. As with using any tool, the resulting contribution is | ||
| the responsibility of the contributor. We value good code, concise accurate documentation, and avoiding unneeded code | ||
| churn. Discretion, good judgment, and critical thinking are the foundation of all good contributions, regardless of the | ||
| tools used in their creation. | ||
| Generative AI tools are evolving rapidly, and their work can be helpful. As with using any tool, the resulting | ||
|
Mariatta marked this conversation as resolved.
Outdated
Mariatta marked this conversation as resolved.
Outdated
Mariatta marked this conversation as resolved.
Outdated
|
||
| contribution is the responsibility of the contributor. We value good code, concise accurate documentation, | ||
| and avoiding unneeded code churn. Discretion, good judgment, and critical thinking are the foundation of all good | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
| contributions, regardless of the tools used in their creation. | ||
|
|
||
| Considerations for success | ||
| ========================== | ||
|
|
||
| Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR. | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
|
|
||
| We expect PR authors to be able to explain their proposed changes in their own words. | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
|
|
||
| Disclosure of the use of AI tools in the PR description is appreciated, while not required. Be prepared to explain how | ||
| the tool was used and what changes it made. | ||
|
|
||
| Whether you are using Generative AI or not, keep the following principles in mind for the quality | ||
| of your contribution: | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
|
|
||
| - Consider whether the change is necessary | ||
| - Make minimal, focused changes | ||
| - Follow existing coding style and patterns | ||
| - Write tests that exercise the change | ||
|
|
||
| Acceptable uses | ||
| =============== | ||
|
|
@@ -21,20 +39,10 @@ Some of the acceptable uses of generative AI include: | |
| Unacceptable uses | ||
| ================= | ||
|
|
||
| Maintainers may close issues and PRs that are not useful or productive, including | ||
| those that are fully generated by AI. If a contributor repeatedly opens unproductive | ||
| issues or PRs, they may be blocked. | ||
| Maintainers may close issues and PRs that are not useful or productive, regardless of whether | ||
| AI was used or not. | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
|
|
||
| Considerations for success | ||
| ========================== | ||
| - While AI assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. | ||
| This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. | ||
| Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. | ||
| - Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. | ||
| Such changes do not represent a real fix. Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR. | ||
| - Keep the following principles for the quality of your contributions in mind whether you use generative AI or not: | ||
|
|
||
| - Consider whether the change is necessary | ||
| - Make minimal, focused changes | ||
| - Follow existing coding style and patterns | ||
| - Write tests that exercise the change | ||
| If a contributor repeatedly opens unproductive issues or PRs, they may be blocked. | ||
|
Mariatta marked this conversation as resolved.
Outdated
|
||
|
|
||
| Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the | ||
| underlying problem in the code. Such changes do not represent a real fix and are not acceptable. | ||
|
Mariatta marked this conversation as resolved.
Outdated
Mariatta marked this conversation as resolved.
Outdated
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.