Skip to content

Commit 84a3b2d

Browse files
RafaelGSSjasnelltrivikr
authored
Apply suggestions from code review
Co-authored-by: James M Snell <jasnell@gmail.com> Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
1 parent 68d04f4 commit 84a3b2d

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

doc/contributing/ai-guidelines.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ never be "I'm not sure. The AI did it."
1919
If AI tools assisted in generating a contribution, acknowledge that honestly.
2020
Regardless of how much code is generated by AI, disclosure does not serve
2121
as a disclaimer of responsibility.
22+
2223
The contributor remains the sole author and bears full responsibility for every line.
2324
If the disclosure involves trademarks or commercial brands, it's recommended to
2425
anonymize it in the commit message or only mention the brand/trademark in the
2526
PR description, but not in the commit message, unless the context would not
2627
have made sense without mentioning the specific brand/trademark. The goal
27-
is to prevent the commit messages, which are part of the code base, from being
28-
abused for for-profit marketing.
28+
is to prevent the commit messages, which are part of the codebase, from being
29+
abused for profit-driven marketing.
2930

3031
Pull requests that contain AI-generated code the contributor has not
3132
personally understood, tested, and verified waste collaborator time and
@@ -78,7 +79,7 @@ When using AI as a coding assistant:
7879
* **Do not use AI to claim "good first issue" tasks.** These issues exist to
7980
help new contributors learn the codebase and processes hands-on.
8081

81-
* **Edit generated comments critically.** LLM-produced comments are often
82+
* **Edit generated comments critically.** LLM-generated comments are often
8283
verbose or inaccurate. Remove comments that simply restate what the code
8384
does; add comments only where the logic is non-obvious.
8485

0 commit comments

Comments
 (0)