Skip to content

Commit

Permalink
Add a brief page on Generative AI usage (#1451)
Browse files Browse the repository at this point in the history
* Add a brief page on Generative AI usage

* Apply suggestions from code review from Jelle and Hugo

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

* Add suggested wording from jelle

---------

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
  • Loading branch information
3 people authored Oct 22, 2024
1 parent d20061f commit 1ffa42a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
26 changes: 26 additions & 0 deletions getting-started/generative-ai.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _generative-ai:

=============
Generative AI
=============

Generative AI has evolved rapidly over the past decade and will continue in the future.
Using generative AI and large language models (LLMs) can be helpful tools for contributors.
Their overuse can also be problematic, such as generation of incorrect code, inaccurate documentation, and unneeded code churn.
Discretion, good judgement, and critical thinking **must** be used when opening issues and pull requests.

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, including
those that are fully generated by AI. If a contributor repeatedly opens unproductive
issues or PRs, they may be blocked.
1 change: 1 addition & 0 deletions getting-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Getting started
git-boot-camp
pull-request-lifecycle
getting-help
generative-ai

0 comments on commit 1ffa42a

Please sign in to comment.