You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: getting-started/ai-tools.rst
+28-19Lines changed: 28 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,40 @@
4
4
Guidelines for using AI tools
5
5
=============================
6
6
7
-
The person submitting an issue or PR is responsible for its content, regardless of whether
8
-
AI tools were used in its creation. Generative AI tools can produce output quickly, but
9
-
discretion, good judgment, and critical thinking are the foundation of all good contributions.
10
-
We value good code, concise accurate documentation, and well scoped PRs without unneeded
11
-
code churn.
7
+
The person submitting an issue or PR is responsible for its content,
8
+
regardless of whether AI tools were used in its creation. Generative AI
9
+
tools can produce output quickly, but discretion, good judgment, and
10
+
critical thinking are the foundation of all good contributions. We value
11
+
good code, concise accurate documentation, and well scoped PRs without
12
+
unneeded code churn.
12
13
13
14
Considerations for success
14
15
==========================
15
16
16
-
Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR or filing it as an issue.
17
+
Authors must review the work done by AI tooling in detail to ensure it
18
+
actually makes sense before proposing it as a PR or filing it as an issue.
17
19
18
-
We expect PR authors and those filing issues to be able to explain their proposed changes in their own words.
20
+
We expect PR authors and those filing issues to be able to explain their
21
+
proposed changes in their own words.
19
22
20
-
Disclosure of the use of AI tools in the PR description is appreciated, while not required. Be prepared to explain how
21
-
the tool was used and what changes it made.
23
+
Disclosure of the use of AI tools in the PR description is appreciated,
24
+
while not required. Be prepared to explain how the tool was used and what
25
+
changes it made.
22
26
23
-
Whether you are using AI tools or not, keep the following principles in mind for the quality
24
-
of your contribution:
27
+
Whether you are using AI tools or not, keep the following principles in
28
+
mind for the quality of your contribution:
25
29
26
30
- Consider whether the change is necessary
27
31
- Make minimal, focused changes
28
32
- Follow existing coding style and patterns
29
33
- Write tests that exercise the change
30
-
- Keep backwards compatibility with prior releases in mind. Existing tests may be ensuring specific API behaviors are maintained.
34
+
- Keep backwards compatibility with prior releases in mind. Existing
35
+
tests may be ensuring specific API behaviors are maintained.
31
36
32
-
Pay close attention to AI generated recommendations for testing changes. Provide input about Python's testing principles when guiding an AI model. Always review the output before opening a pull request or issue, including proposed PR or issue titles and descriptions.
37
+
Pay close attention to AI generated recommendations for testing changes.
38
+
Provide input about Python's testing principles when guiding an AI model.
39
+
Always review the output before opening a pull request or issue,
40
+
including proposed PR or issue titles and descriptions.
33
41
34
42
Acceptable uses
35
43
===============
@@ -43,12 +51,13 @@ Some of the acceptable uses of generative AI include:
43
51
Unacceptable uses
44
52
=================
45
53
46
-
Maintainers may close issues and PRs that are not useful or productive, regardless of whether
47
-
AI tools were used or not.
54
+
Maintainers may close issues and PRs that are not useful or productive,
55
+
regardless of whether AI tools were used or not.
48
56
49
57
If a contributor repeatedly opens unproductive issues or PRs, they may be
50
-
blocked from contributing to the project because it is disruptive and disrespectful
51
-
of the maintainers time.
58
+
blocked from contributing to the project because it is disruptive and
59
+
disrespectful of the maintainers time.
52
60
53
-
It is not acceptable to alter or bypass existing tests, or remove desired functionality, in order
54
-
to make a failing test pass. Such changes are not a real fix.
61
+
It is not acceptable to alter or bypass existing tests, or remove desired
62
+
functionality, in order to make a failing test pass. Such changes are not
0 commit comments