Skip to content

Commit c827f75

Browse files
Mariattasavannahostrowskiwillingc
authored
Apply suggestions from code review
Co-authored-by: Savannah Ostrowski <savannah@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
1 parent ff94cd6 commit c827f75

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

getting-started/generative-ai.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
.. _generative-ai:
1+
.. _ai-tools:
22

33
=================================
4-
Guidelines in using Generative AI
4+
Guidelines for using AI tools
55
=================================
66

7-
Generative AI tools are evolving rapidly, and their work can be helpful. As with using any tool, the resulting
7+
Generative AI tools can produce output quickly. As with using any tool, the resulting
88
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
9+
and well scoped PRs without unneeded code churn. Discretion, good judgment, and critical thinking are the foundation of all good
1010
contributions, regardless of the tools used in their creation.
1111

1212
Considerations for success
1313
==========================
1414

15-
Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR.
15+
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.
1616

17-
We expect PR authors to be able to explain their proposed changes in their own words.
17+
We expect PR authors and those filing issues to be able to explain their proposed changes in their own words.
1818

1919
Disclosure of the use of AI tools in the PR description is appreciated, while not required. Be prepared to explain how
2020
the tool was used and what changes it made.
2121

22-
Whether you are using Generative AI or not, keep the following principles in mind for the quality
22+
Whether you are using AI tools or not, keep the following principles in mind for the quality
2323
of your contribution:
2424

2525
- Consider whether the change is necessary
@@ -40,7 +40,7 @@ Unacceptable uses
4040
=================
4141

4242
Maintainers may close issues and PRs that are not useful or productive, regardless of whether
43-
AI was used or not.
43+
AI tools were used or not.
4444

4545
If a contributor repeatedly opens unproductive issues or PRs, they may be blocked.
4646

index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Guide for contributing to Python:
4040
* :ref:`rst-primer`
4141
* :ref:`translating`
4242
* :ref:`devguide`
43-
* :ref:`generative-ai`
43+
* :ref:`ai-tools`
4444
-
4545
* :ref:`setup`
4646
* :ref:`help`
@@ -50,7 +50,7 @@ Guide for contributing to Python:
5050
* :ref:`communication`
5151
* :ref:`gitbootcamp`
5252
* :ref:`devcycle`
53-
* :ref:`generative-ai`
53+
* :ref:`ai-tools`
5454
-
5555
* :ref:`tracker`
5656
* :ref:`triaging`

0 commit comments

Comments
 (0)