From 55e0a9e3b38f83260d3ba206ee4f81119d20bdf3 Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 1 Nov 2025 18:04:59 +0900 Subject: [PATCH 01/10] generative-ai: Add anti pattern example --- getting-started/generative-ai.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 90fe020f3..e6d35c591 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -24,3 +24,10 @@ 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. + +Anti-patterns +============= +- While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. + This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. + Please keep maintaining consistency with the original code helps preserve clarity, traceability, and meaningful review. + From 2a102b844631625985992503044f31b9a76eb9d9 Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 1 Nov 2025 18:51:19 +0900 Subject: [PATCH 02/10] reformat --- getting-started/generative-ai.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index e6d35c591..02dad6d06 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -30,4 +30,3 @@ Anti-patterns - While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. Please keep maintaining consistency with the original code helps preserve clarity, traceability, and meaningful review. - From 7a7bec220fa256c734f266a52186905d8b69328f Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 1 Nov 2025 20:05:25 +0900 Subject: [PATCH 03/10] Address code review --- getting-started/generative-ai.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 02dad6d06..f15bdcc7d 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -29,4 +29,4 @@ Anti-patterns ============= - While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. - Please keep maintaining consistency with the original code helps preserve clarity, traceability, and meaningful review. + Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. From f0e60d096a1ce35f1449fc1b73932eb7e654b287 Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 1 Nov 2025 20:09:03 +0900 Subject: [PATCH 04/10] Add one more case --- getting-started/generative-ai.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index f15bdcc7d..6c88fd7db 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -30,3 +30,5 @@ Anti-patterns - While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. +- Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. + Such changes do not represent a real fix and should be avoided. From 131f62fdeee10cf092443c0623c5e658f0251f55 Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 1 Nov 2025 20:20:13 +0900 Subject: [PATCH 05/10] reformat --- getting-started/generative-ai.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 6c88fd7db..7a83fbc7a 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -30,5 +30,5 @@ Anti-patterns - While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. -- Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. +- Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. Such changes do not represent a real fix and should be avoided. From f7d40f83bfe2e53faae858805ac65de6f51db65f Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 8 Nov 2025 10:42:46 +0900 Subject: [PATCH 06/10] Address code review --- getting-started/generative-ai.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 7a83fbc7a..ac203dd04 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -4,10 +4,10 @@ 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. +Generative AI has evolved rapidly and can be impressive. As with using any tool, the resulting contribution is +the responsibility of the contributor. We value good code, concise accurate documentation, and avoiding unneeded code +churn. Discretion, good judgment, and critical thinking are the foundation of all good contributions, regardless of the +tools used in their creation. Acceptable uses =============== @@ -25,10 +25,10 @@ Maintainers may close issues and PRs that are not useful or productive, includin those that are fully generated by AI. If a contributor repeatedly opens unproductive issues or PRs, they may be blocked. -Anti-patterns -============= -- While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. +Considerations or Keys for Success +================================== +- While AI assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. - Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. - Such changes do not represent a real fix and should be avoided. + Such changes do not represent a real fix. Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR. From 3b1b75c75bcbbd4d4fe58e9a5667b64107485d40 Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sat, 8 Nov 2025 10:44:16 +0900 Subject: [PATCH 07/10] fix --- getting-started/generative-ai.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index ac203dd04..d67e98692 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -32,3 +32,8 @@ Considerations or Keys for Success Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. - Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. Such changes do not represent a real fix. Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR. +- Please keep following principles for the quality of your contributions in mind whether you use generative AI or not: + - Consider whether the change is necessary. + - Make minimal, focused changes. + - Follow existing coding style and patterns. + - Write tests that exercise the change. From fdc2c42b5b2b0f2c44f7b745d2f7d4392aafbd90 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 8 Nov 2025 14:59:38 -0800 Subject: [PATCH 08/10] Update heading and use sentence case Co-authored-by: Ned Batchelder --- getting-started/generative-ai.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index d67e98692..2b6cb6730 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -25,7 +25,7 @@ Maintainers may close issues and PRs that are not useful or productive, includin those that are fully generated by AI. If a contributor repeatedly opens unproductive issues or PRs, they may be blocked. -Considerations or Keys for Success +Considerations for success ================================== - While AI assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. From 65f3bbe88d37f16257835f01ec551755b9576b02 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 8 Nov 2025 15:00:19 -0800 Subject: [PATCH 09/10] Improve wording and spacing for principles Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- getting-started/generative-ai.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index 2b6cb6730..a60f35b27 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -32,8 +32,9 @@ Considerations for success Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn. - Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code. Such changes do not represent a real fix. Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR. -- Please keep following principles for the quality of your contributions in mind whether you use generative AI or not: - - Consider whether the change is necessary. - - Make minimal, focused changes. - - Follow existing coding style and patterns. - - Write tests that exercise the change. +- Keep the following principles for the quality of your contributions in mind whether you use generative AI or not: + + - Consider whether the change is necessary + - Make minimal, focused changes + - Follow existing coding style and patterns + - Write tests that exercise the change From cf1642eb8d74d8626130e87af42cd8f453f47582 Mon Sep 17 00:00:00 2001 From: Donghee Na Date: Sun, 9 Nov 2025 13:08:04 +0900 Subject: [PATCH 10/10] Apply suggestions from code review Co-authored-by: Carol Willing --- getting-started/generative-ai.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/getting-started/generative-ai.rst b/getting-started/generative-ai.rst index a60f35b27..e4aa3e758 100644 --- a/getting-started/generative-ai.rst +++ b/getting-started/generative-ai.rst @@ -4,7 +4,7 @@ Generative AI ============= -Generative AI has evolved rapidly and can be impressive. As with using any tool, the resulting contribution is +Generative AI tools have evolved rapidly, and their suggested results can be helpful. As with using any tool, the resulting contribution is the responsibility of the contributor. We value good code, concise accurate documentation, and avoiding unneeded code churn. Discretion, good judgment, and critical thinking are the foundation of all good contributions, regardless of the tools used in their creation. @@ -26,7 +26,7 @@ those that are fully generated by AI. If a contributor repeatedly opens unproduc issues or PRs, they may be blocked. Considerations for success -================================== +========================== - While AI assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits. This can make it more difficult to review changes and to fully understand both the original intent of the code and the rationale behind the new modifications. Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn.