Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit01c6b87

Browse files
corona10willingcnedbathugovk
authored
generative-ai: Add anti pattern example (gh-1679)
* generative-ai: Add anti pattern example* reformat* Address code review* Add one more case* reformat* Address code review* fix* Update heading and use sentence caseCo-authored-by: Ned Batchelder <ned@nedbatchelder.com>* Improve wording and spacing for principlesCo-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>* Apply suggestions from code reviewCo-authored-by: Carol Willing <carolcode@willingconsulting.com>---------Co-authored-by: Carol Willing <carolcode@willingconsulting.com>Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent006ad0e commit01c6b87

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

‎getting-started/generative-ai.rst‎

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

7-
Generative AIhasevolved rapidly over the past decade and will continue inthefuture.
8-
Using generative AI and large language models (LLMs) can be helpful tools for contributors.
9-
Their overuse can also be problematic, such as generationofincorrect code, inaccurate documentation, and unneeded code churn.
10-
Discretion, good judgement, and critical thinking **must** beusedwhen opening issues and pull requests.
7+
Generative AItools haveevolved rapidly, and their suggested results can be helpful. As with using any tool,theresulting 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 foundationofall good contributions, regardless of the
10+
toolsusedin their creation.
1111

1212
Acceptable uses
1313
===============
@@ -24,3 +24,17 @@ Unacceptable uses
2424
Maintainers may close issues and PRs that are not useful or productive, including
2525
those that are fully generated by AI. If a contributor repeatedly opens unproductive
2626
issues or PRs, they may be blocked.
27+
28+
Considerations 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.
31+
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.
32+
Maintaining consistency with the original code helps preserve clarity, traceability, and meaningful reviews and also helps us avoid unnecessary code churn.
33+
- 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. Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR.
35+
- Keep the following principles for the quality of your contributions in mind whether you use generative AI or not:
36+
37+
- Consider whether the change is necessary
38+
- Make minimal, focused changes
39+
- Follow existing coding style and patterns
40+
- Write tests that exercise the change

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp