Skip to content

Commit f7d40f8

Browse files
committed
Address code review
1 parent 131f62f commit f7d40f8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

getting-started/generative-ai.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
Generative AI
55
=============
66

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.
7+
Generative AI has evolved rapidly and can be impressive. As with using any tool, the resulting contribution is
8+
the responsibility of the contributor. We value good code, concise accurate documentation, and avoiding unneeded code
9+
churn. Discretion, good judgment, and critical thinking are the foundation of all good contributions, regardless of the
10+
tools used in their creation.
1111

1212
Acceptable uses
1313
===============
@@ -25,10 +25,10 @@ Maintainers may close issues and PRs that are not useful or productive, includin
2525
those that are fully generated by AI. If a contributor repeatedly opens unproductive
2626
issues or PRs, they may be blocked.
2727

28-
Anti-patterns
29-
=============
30-
- While AI-assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits.
28+
Considerations or Keys for Success
29+
==================================
30+
- While AI assisted tools such as autocompletion can enhance productivity, they sometimes rewrite entire code blocks instead of making small, focused edits.
3131
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.
3232
Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn.
3333
- Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the underlying problem in the code.
34-
Such changes do not represent a real fix and should be avoided.
34+
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.

0 commit comments

Comments
 (0)