8000 Add a brief page on Generative AI usage (#1451) · Studentofcode1/devguide@1ffa42a · GitHub
[go: up one dir, main page]

Skip to content

Commit 1ffa42a

Browse files
willingchugovkJelleZijlstra
authored
Add a brief page on Generative AI usage (python#1451)
* 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>
1 parent d20061f commit 1ffa42a

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

getting-started/generative-ai.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _generative-ai:
2+
3+
=============
4+
Generative AI
5+
=============
6+
7+
Generative AI has evolved rapidly over the past decade and will continue in the future.
8+
Using generative AI and large language models (LLMs) can be helpful tools for contributors.
9+
Their overuse can also be problematic, such as generation of incorrect code, inaccurate documentation, and unneeded code churn.
10+
Discretion, good judgement, and critical thinking **must** be used when opening issues and pull requests.
11+
12+
Acceptable uses
13+
===============
14+
15+
Some of the acceptable uses of generative AI include:
16+
17+
- Assistance with writing comments, especially in a non-native language
18+
- Gaining understanding of existing code
19+
- Supplementing contributor knowledge for code, tests, and documentation
20+
21+
Unacceptable uses
22+
=================
23+
24+
Maintainers may close issues and PRs that are not useful or productive, including
25+
those that are fully generated by AI. If a contributor repeatedly opens unproductive
26+
issues or PRs, they may be blocked.

getting-started/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ Getting started
1212
git-boot-camp
1313
pull-request-lifecycle
1414
getting-help
15+
generative-ai

0 commit comments

Comments
 (0)
0