Skip to content

Commit cc0ff01

Browse files
committed
Reformat to 80 chars max
1 parent 52757df commit cc0ff01

1 file changed

Lines changed: 28 additions & 19 deletions

File tree

getting-started/ai-tools.rst

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,40 @@
44
Guidelines for using AI tools
55
=============================
66

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.
1213

1314
Considerations for success
1415
==========================
1516

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.
1719

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.
1922

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.
2226

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:
2529

2630
- Consider whether the change is necessary
2731
- Make minimal, focused changes
2832
- Follow existing coding style and patterns
2933
- 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.
3136

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.
3341

3442
Acceptable uses
3543
===============
@@ -43,12 +51,13 @@ Some of the acceptable uses of generative AI include:
4351
Unacceptable uses
4452
=================
4553

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.
4856

4957
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.
5260

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
63+
a real fix.

0 commit comments

Comments
 (0)