Skip to content
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.

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

Add a brief page on Generative AI usage #1451

Merged
merged 3 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
25 changes: 25 additions & 0 deletions getting-started/generative-ai.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _generative-ai:

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

Generative AI has evolved rapidly over the past decade and will continue in the future.
Using Generative AI and LLMs (Large Language Models) can be helpful tools for contributors.
willingc marked this conversation as resolved.
Show resolved Hide resolved
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
willingc marked this conversation as resolved.
Show resolved Hide resolved
- Gaining understanding of existing code
- Supplementing contributor knowledge for code, tests, and documentation

Unacceptable uses
=================

If a maintainer believes that a PR or issue was **fully generated** by AI tools, the PR or issue will be closed.
willingc marked this conversation as resolved.
Show resolved Hide resolved
If a contributor opens multiple, fully generated AI issues or PRs, the contributor may be blocked.
willingc marked this conversation as resolved.
Show resolved Hide resolved
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
Loading