Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update guidelines on using GenAI #1778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mariatta wants to merge 6 commits into
base: main
Choose a base branch
from
+33 −23
Open

Update guidelines on using GenAI #1778

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
726ec3c
Update guidelines on using GenAI
Mariatta Apr 8, 2026
e71105b
Update getting-started/generative-ai.rst
Mariatta Apr 9, 2026
f8ab6ab
Update the title to clarify the purpose of this doc is to provide gui…
Mariatta Apr 9, 2026
a04cd52
Fix the markup in rendering the table
Mariatta Apr 9, 2026
ef31ff8
Soften the wording about AI tool disclosure.
Mariatta Apr 9, 2026
ff94cd6
Moved the considerations to be earlier in the page.
Mariatta Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update the title to clarify the purpose of this doc is to provide gui… 
…delines.

Add the Guidelines to the contributing table.
  • Loading branch information
@Mariatta
Mariatta committed Apr 9, 2026
commit f8ab6abc03f6074ae1e7d8791383a65f9daff195
8 changes: 4 additions & 4 deletions getting-started/generative-ai.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _generative-ai:
Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. _generative-ai:
.. _ai-tools:


=============
Generative AI
=============
=================================
Guidelines in using Generative AI
Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Guidelines in using Generative AI
Guidelines for using AI tools

=================================
Comment on lines +3 to +5
Copy link
Copy Markdown
Member

@hugovk hugovk Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
=================================
Guidelines in using Generative AI
=================================
=================================
Guidelines on using Generative AI
=================================


Generative AI tools are evolving rapidly, and their work can be helpful. As with using any tool, the resulting
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It wasn't done before in this file for some reason, but could we please wrap lines?

Copy link
Copy Markdown
Member

@hugovk hugovk Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to say the opposite :)

The rewrap make it hard to review what has changed. Please can we keep a minimal diff for now, and only rewrap just before merge?

Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just before merge sounds good to me :-)

Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Generative AI tools are evolving rapidly, and their work can be helpful. As with using any tool, the resulting
Generative AI tools can produce output quickly. As with using any tool, the resulting

Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should personify the tools any longer. I also want to be more objective about the results.

Copy link
Copy Markdown
Member

@gpshead gpshead Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps just simplify to:

"AI tools can produce results quickly. As with using any ..."

FWIW, "their work" was not intended as personification, it a extremely common phrase for how we refer to any machines or really any objects serving any purpose in English. good bad or indifferent.

We should remove the word "Generative" to simplify this further. "produce output" reads as rather a diss on AI models and agentic harnesses that belittles their (non-personified) capabilities that would make for a somewhat dated feeling policy. "results" is more what people are looking for and encompasses all sorts of actions taken.

I don't like saying "produce output" for the same reason that "generative" doesn't quite have the right ring to it. Internally things done by agentic AI are is technically "output" in the output tokens turning into tool calls that iteratively converge on the goals we asked for sense. But AI users see the end result rather than how it happened inside.

Copy link
Copy Markdown
Contributor

@hauntsaninja hauntsaninja Apr 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"produce output quickly" is pretty different from the original intent of this sentence, which to me is talking about the rate of change of tools themselves

The speed of generation is not really relevant in my mind, but the acknowledgement that our guidelines may not contain everything that is most helpful to the reader in whatever latest state of the world they find themself in is

Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gpshead @hauntsaninja When I originally authored the doc back in October 2024, the industry and tool availability was very different than today.

I think it makes good sense to drop the term Generative AI in most of this document and go with the simpler term "AI tools".

Copy link
Copy Markdown
Member

@savannahostrowski savannahostrowski Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Generative AI tools are evolving rapidly, and their work can be helpful. As with using any tool, the resulting
AI tooling is evolving rapidly, and their work can be helpful. As with using any tool, the resulting

contribution is the responsibility of the contributor. We value good code, concise accurate documentation,
Expand Down Expand Up @@ -36,7 +36,7 @@ Authors must review the work done by AI tooling in detail to ensure it actually

We expect PR authors to be able to explain their proposed changes in their own words.

Disclose the use of AI tools in the PR description, and be prepared to explain how the tool was used and what
Disclosure of the use of AI tools in the PR description, and be prepared to explain how the tool was used and what
changes it made.

Whether you are using Generative AI or not, keep the following principles in mind for the quality
Expand Down
4 changes: 3 additions & 1 deletion index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Guide for contributing to Python:
* :ref:`rst-primer`
* :ref:`translating`
* :ref:`devguide`
* :ref:`generative-ai`
Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`generative-ai`
* :ref:`ai-tools`

-
* :ref:`setup`
* :ref:`help`
Expand All @@ -49,7 +50,8 @@ Guide for contributing to Python:
* :ref:`communication`
* :ref:`gitbootcamp`
* :ref:`devcycle`
-
* :ref:`generative-ai`
Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`generative-ai`
* :ref:`ai-tools`

-
* :ref:`tracker`
* :ref:`triaging`
* :ref:`helptriage`
Expand Down
Loading