fix(bmm): suppress epic/story comments and AI slop in generated code#2544
fix(bmm): suppress epic/story comments and AI slop in generated code#2544N0wah wants to merge 1 commit into
Conversation
Add code comment quality constraints to bmad-agent-dev principles and bmad-dev-story persistent_facts to prevent injection of epic/story references and verbose AI-generated noise in produced code. Fixes bmad-code-org#2538
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughTwo customize.toml configuration files were updated to add three new rule entries each, restricting inline code comments from referencing epics/stories, requiring comments to explain rationale rather than process metadata, and mandating production-ready generated code. ChangesComment style constraints
Estimated code review effort: 1 (Trivial) | ~3 minutes Related issues: Suggested labels: documentation, configuration Suggested reviewers: N/A Poem:
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
|
Directionally, I like this. But!
|
Problem
The
bmad-agent-devagent andbmad-dev-storyskill inject excessive noise into generated code:# Epic: X,# Story: PROJ-42)Fixes #2538
Solution
Added explicit code comment quality constraints:
bmad-agent-dev/customize.toml— added 3 principles to the agent's value system prohibiting epic/story refs, enforcing "why not what" commenting, and requiring production-ready clean codebmad-dev-story/customize.toml— added the same constraints aspersistent_factsso the skill carries them throughout the whole workflow runTesting
Load the
bmad-agent-devagent and run a story implementation — the generated code should no longer contain epic/story comment references or verbose AI noise.