Update guidelines on using GenAI (#1778)

* Update guidelines on using GenAI
* Update the title to clarify the purpose of this doc is to provide guidelines.
* Add the Guidelines to the contributing table.
* Fix the markup in rendering the table
* Soften the wording about AI tool disclosure.
* Moved the considerations to be earlier in the page.
* Apply suggestions from code review
* Add more explicit in the beginning that the person submitting issue or pr is responsible for its content.
* adjust wording about being disrespectful and about reviewing the output always.
* Rename the file to ai-tools.rst
* Reformat to 80 chars max
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>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Savannah Ostrowski <savannah@python.org>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

Author: 7 people

conf.py

@@ -205,7 +205,7 @@
     "contrib/project/github.rst": "index.rst",
     "contrib/project/governance.rst": "index.rst",
     "contrib/project/roles.rst": "index.rst",
-    "contrib/project/generative-ai.rst": "getting-started/generative-ai.rst",
+    "contrib/project/ai-tools.rst": "getting-started/ai-tools.rst",
     "contrib/project/outreach.rst": "index.rst",
     "contrib/project/directory-structure.rst": "getting-started/setup-building.rst",
     "contrib/project/index.rst": "index.rst",

getting-started/ai-tools.rst

@@ -0,0 +1,63 @@
+.. _ai-tools:
+
+=============================
+Guidelines for using AI tools
+=============================
+
+The person submitting an issue or PR is responsible for its content,
+regardless of whether AI tools were used in its creation. Generative AI
+tools can produce output quickly, but discretion, good judgment, and
+critical thinking are the foundation of all good contributions. We value
+good code, concise accurate documentation, and well scoped PRs without
+unneeded code churn.
+
+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 or filing it as an issue.
+
+We expect PR authors and those filing issues to be able to explain their
+proposed changes in their own words.
+
+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 AI tools or not, keep the following principles in
+mind for the quality of your contribution:
+
+- Consider whether the change is necessary
+- Make minimal, focused changes
+- Follow existing coding style and patterns
+- Write tests that exercise the change
+- Keep backwards compatibility with prior releases in mind. Existing
+  tests may be ensuring specific API behaviors are maintained.
+
+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.
+
+Acceptable uses
+===============
+
+Some of the acceptable uses of generative AI include:
+
+- Assistance with writing comments, especially in a non-native language
+- Gaining understanding of existing code
+- Supplementing contributor knowledge for code, tests, and documentation
+
+Unacceptable uses
+=================
+
+Maintainers may close issues and PRs that are not useful or productive,
+regardless of whether AI tools were used or not.
+
+If a contributor repeatedly opens unproductive issues or PRs, they may be
+blocked from contributing to the project because it is disruptive and
+disrespectful of the maintainers time.
+
+It is not acceptable to alter or bypass existing tests, or remove desired
+functionality, in order to make a failing test pass. Such changes are not
+a real fix.

getting-started/generative-ai.rst

@@ -12,4 +12,4 @@ Getting started
    git-boot-camp
    pull-request-lifecycle
    getting-help
-   generative-ai
+   ai-tools

getting-started/index.rst

@@ -40,6 +40,7 @@ Guide for contributing to Python:
        * :ref:`rst-primer`
        * :ref:`translating`
        * :ref:`devguide`
+       * :ref:`ai-tools`
      -
        * :ref:`setup`
        * :ref:`help`
@@ -49,6 +50,7 @@ Guide for contributing to Python:
        * :ref:`communication`
        * :ref:`gitbootcamp`
        * :ref:`devcycle`
+       * :ref:`ai-tools`
      -
        * :ref:`tracker`
        * :ref:`triaging`