Skip to content

Commit 726ec3c

Browse files
Mariattagpsheadcorona10devdanzin
committed
Update guidelines on using GenAI
Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Donghee Na <donghee.na@python.org> Co-authored-by: devdanzin <74280297+devdanzin@users.noreply.github.com>
1 parent d73c383 commit 726ec3c

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

getting-started/generative-ai.rst

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
Generative AI
55
=============
66

7-
Generative AI tools have evolved rapidly, and their suggested results can be helpful. As with using any tool, the resulting contribution is
8-
the responsibility of the contributor. We value good code, concise accurate documentation, and avoiding unneeded code
9-
churn. Discretion, good judgment, and critical thinking are the foundation of all good contributions, regardless of the
10-
tools used in their creation.
7+
Generative AI tools are evolving rapidly, and their work can be helpful. As with using any tool, the resulting
8+
contribution is the responsibility of the contributor. We value good code, concise accurate documentation,
9+
and avoiding unneeded code churn. Discretion, good judgment, and critical thinking are the foundation of all good
10+
contributions, regardless of the tools used in their creation.
1111

1212
Acceptable uses
1313
===============
@@ -21,20 +21,28 @@ Some of the acceptable uses of generative AI include:
2121
Unacceptable uses
2222
=================
2323

24-
Maintainers may close issues and PRs that are not useful or productive, including
25-
those that are fully generated by AI. If a contributor repeatedly opens unproductive
26-
issues or PRs, they may be blocked.
24+
Maintainers may close issues and PRs that are not useful or productive, regardless whether
25+
AI was used or not.
26+
27+
If a contributor repeatedly opens unproductive issues or PRs, they may be blocked.
28+
29+
Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the
30+
underlying problem in the code. Such changes do not represent a real fix and are not acceptable.
2731

2832
Considerations for success
2933
==========================
30-
- While AI assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits.
31-
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.
32-
Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn.
33-
- Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code.
34-
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.
35-
- Keep the following principles for the quality of your contributions in mind whether you use generative AI or not:
36-
37-
- Consider whether the change is necessary
38-
- Make minimal, focused changes
39-
- Follow existing coding style and patterns
40-
- Write tests that exercise the change
34+
35+
Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR.
36+
37+
We expect PR authors to be able to explain their proposed changes in their own words.
38+
39+
Disclose the use of AI tools in the PR description, and be prepared to explain how the tool was used and what
40+
changes it made.
41+
42+
Whether you are using Generative AI or not, keep the following principles in mind for the quality
43+
of your contribution:
44+
45+
- Consider whether the change is necessary
46+
- Make minimal, focused changes
47+
- Follow existing coding style and patterns
48+
- Write tests that exercise the change

0 commit comments

Comments
 (0)