From 8be5ee70fc8027e4e8ebe603a0c31879a6e971b1 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 21 Oct 2024 08:46:42 -0700 Subject: [PATCH 1/3] Add a brief page on Generative AI usage --- getting-started/generative-ai.rst | 25 +++++++++++++++++++++++++ getting-started/index.rst | 1 + 2 files changed, 26 insertions(+) create mode 100644 getting-started/generative-ai.rst diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst new file mode 100644 index 0000000000..885effff90 --- /dev/null +++ b/getting-started/generative-ai.rst @@ -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. +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 +================= + +If a maintainer believes that a PR or issue was **fully generated** by AI tools, the PR or issue will be closed. +If a contributor opens multiple, fully generated AI issues or PRs, the contributor may be blocked. diff --git a/getting-started/index.rst b/getting-started/index.rst index 61eb1d9ab1..05ee67a3bc 100644 --- a/getting-started/index.rst +++ b/getting-started/index.rst @@ -12,3 +12,4 @@ Getting started git-boot-camp pull-request-lifecycle getting-help + generative-ai From ea7a5c92f665be8eb6b6e50e9850a2a92f40a57f Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 21 Oct 2024 09:19:49 -0700 Subject: [PATCH 2/3] 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 --- getting-started/generative-ai.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 885effff90..836882daef 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -5,7 +5,7 @@ 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. +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. @@ -14,7 +14,7 @@ Acceptable uses Some of the acceptable uses of generative AI include: -- Assistance with writing comments, especially in a non-native Language +- Assistance with writing comments, especially in a non-native language - Gaining understanding of existing code - Supplementing contributor knowledge for code, tests, and documentation @@ -22,4 +22,4 @@ Unacceptable uses ================= If a maintainer believes that a PR or issue was **fully generated** by AI tools, the PR or issue will be closed. -If a contributor opens multiple, fully generated AI issues or PRs, the contributor may be blocked. +If a contributor opens multiple fully AI-generated issues or PRs, the contributor may be blocked. From ea29a0ab9a42098620c1476faf63d30a40c23411 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 21 Oct 2024 09:41:05 -0700 Subject: [PATCH 3/3] Add suggested wording from jelle --- getting-started/generative-ai.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 836882daef..90fe020f3f 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -21,5 +21,6 @@ Some of the acceptable uses of generative AI include: Unacceptable uses ================= -If a maintainer believes that a PR or issue was **fully generated** by AI tools, the PR or issue will be closed. -If a contributor opens multiple fully AI-generated issues or PRs, the contributor may be blocked. +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.