Skip to content

Commit 86e7484

Browse files
committed
Add Avoiding AI Slop section to contributing guide
Give contributors concrete, practical guidance on trimming AI-generated noise (em-dashes, filler, diff-restating prose, emoji), and link to the AI policy.
1 parent 5ec2d57 commit 86e7484

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

CONTRIBUTING.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,25 @@ Don't be intimidated by these words.
5151
Pull requests that satisfy Spock's overall direction and goals (see above), are crafted carefully, and aren't aiming too high, have a good chance of getting accepted.
5252
Before doing so, we may ask for some concrete improvements to be made, in which case we hope for your cooperation.
5353

54+
=== Avoiding AI Slop
55+
56+
AI tools are welcome (see our link:AI_POLICY.md[AI policy]), but please review their output carefully before submitting it.
57+
"AI slop" is text or code that looks polished but adds noise, hides a lack of understanding, or simply doesn't match how Spock is written.
58+
It is easy to spot, and it slows down review for everyone.
59+
60+
Please trim the following before you open a pull request or issue:
61+
62+
* Typographic tells such as em-dashes (`--`).
63+
Use plain punctuation, like the rest of this repository.
64+
* Generic filler and marketing tone ("This elegant solution leverages...", "In today's fast-paced world...").
65+
Be direct and factual.
66+
* Over-explaining the obvious in comments, commit messages, or descriptions.
67+
Comment the why, not the what.
68+
* Emoji and decorative headings in code, comments, commit messages, or descriptions.
69+
70+
The simplest rule: every line you submit should be one you understand and would have been comfortable writing yourself.
71+
If a sentence or a piece of code doesn't earn its place, remove it.
72+
5473
=== Guiding Principles
5574

5675
==== Try to avoid breaking stuff

0 commit comments

Comments
 (0)