Add AI/agent contribution guidance#2372
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds an AI-assisted contribution policy, an AGENTS guide with repo-specific agent/testing instructions, an “Avoiding AI Slop” contributor subsection, and documentation that GitHub Actions YAML are generated from Kotlin DSL and must be regenerated after edits. ChangesAI Contribution Framework
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR introduces AI/agent contribution infrastructure: a root
Confidence Score: 4/5Documentation-only change that is safe to merge, but the Claude guidance file won't be picked up by Claude Code on Linux until the filename casing is corrected. All changes are documentation. The one functional concern is that .claude/Claude.md — needs to be renamed to .claude/CLAUDE.md so Claude Code loads it on Linux. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Claude Code agent starts session] --> B{Directory?}
B -->|root| C[".claude/CLAUDE.md (expected)\n.claude/Claude.md (actual — wrong case)"]
B -->|.github/workflows/| D[".github/workflows/CLAUDE.md ✓"]
C -->|import '@../AGENTS.md'| E["Root AGENTS.md\n- spock-specs test module\n- snapshot workflow\n- fork-aware remotes\n- Groovy variant flags\n- CONTRIBUTING.adoc"]
D -->|import '@AGENTS.md'| F[".github/workflows/AGENTS.md\n- Never edit YAML directly\n- Run preprocessWorkflows\n- Commit both .kts + YAML"]
C -. "NOT loaded on Linux\n(case-sensitive FS)" .-> E
Reviews (1): Last reviewed commit: "Add Avoiding AI Slop section to contribu..." | Re-trigger Greptile |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.adoc`:
- Around line 62-64: The three bullet lines in the CONTRIBUTING.adoc fragment
(the bullets starting with "Typographic tells such as em-dashes (`--`).",
"Generic filler and marketing tone (\"This elegant solution leverages...\", \"In
today's fast-paced world...\").", and "Over-explaining the obvious in comments,
commit messages, or descriptions. Comment the why, not the what.") each contain
two sentences on a single line—split each into separate lines so there is one
sentence per line; preserve the exact sentence text and list order and ensure
the lines remain bullets under the same list (follow the "one sentence per line"
Asciidoc convention referenced in the Code Standards/Avoiding AI Slop guidance).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d3ffa996-8da9-4255-b7c1-43bc933996ed
📒 Files selected for processing (6)
.claude/Claude.md.github/workflows/AGENTS.md.github/workflows/CLAUDE.mdAGENTS.mdAI_POLICY.mdCONTRIBUTING.adoc
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2372 +/- ##
=========================================
Coverage 82.18% 82.18%
+ Complexity 4832 4831 -1
=========================================
Files 473 473
Lines 15051 15051
Branches 1912 1912
=========================================
Hits 12369 12369
Misses 1991 1991
Partials 691 691 🚀 New features to boost your workflow:
|
Document repo conventions for coding agents: spock-specs test location, fork-aware git remotes, snapshot-test workflow (-PupdateSnapshots, snapshotId), and Groovy/Java variant selection. Add a scoped .github/workflows/AGENTS.md covering the *.main.kts to YAML regeneration step, and CLAUDE.md importers (@AGENTS.md) so both Claude and AGENTS.md-based tooling pick up the guidance without duplication.
Welcome AI-assisted contributions while asking contributors to understand and stand behind what they submit, and to prefer issues or discussions over large unsolicited pull requests.
leonard84
force-pushed
the
ai-contribution-guidance
branch
from
29ba0aa to
7384835
Compare
Give contributors concrete, practical guidance on trimming AI-generated noise (em-dashes, filler, diff-restating prose, emoji), and link to the AI policy.
leonard84
force-pushed
the
ai-contribution-guidance
branch
from
7384835 to
261f7e8
Compare
1 participant
Adds guidance for AI-assisted and agent-driven contributions, plus an
AGENTS.mdto help coding agents work in this repo correctly.Changes
AGENTS.md(new): repo conventions for coding agents. Points atCONTRIBUTING.adocfor the authoritative standards, and captures a few things agents otherwise get wrong: tests forspock-corelive inspock-specs, fork-aware git remotes, the snapshot-test workflow (-PupdateSnapshots,snapshotId), and Groovy/Java variant selection. A scoped.github/workflows/AGENTS.mdcovers the*.main.kts-> YAML regeneration step.CLAUDE.mdfiles just@-import theAGENTS.mdso both Claude and AGENTS.md-based tooling pick up the guidance without duplication.AI_POLICY.md(new): states that AI-assisted contributions are welcome, provided the contributor understands the code well enough to judge and stand behind the output, and that we strongly prefer issues/discussion over large unsolicited pull requests.CONTRIBUTING.adoc: new "Avoiding AI Slop" section with concrete, practical guidance (em-dashes, filler, diff-restating prose, emoji), linking to the AI policy.AI involvement
Disclosed per the new policy: this PR was drafted with AI assistance and reviewed before submission.