Skip to content

fix(bmm): suppress epic/story comments and AI slop in generated code#2544

Open
N0wah wants to merge 1 commit into
bmad-code-org:mainfrom
N0wah:fix/no-epic-story-comments-in-code
Open

fix(bmm): suppress epic/story comments and AI slop in generated code#2544
N0wah wants to merge 1 commit into
bmad-code-org:mainfrom
N0wah:fix/no-epic-story-comments-in-code

Conversation

@N0wah

@N0wah N0wah commented Jul 3, 2026

Copy link
Copy Markdown

Problem

The bmad-agent-dev agent and bmad-dev-story skill inject excessive noise into generated code:

  • Epic/story references as inline comments (# Epic: X, # Story: PROJ-42)
  • Verbose AI-generated explanatory comments ("AI slop")
  • Workflow metadata that has no place in production source code

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 code
  • bmad-dev-story/customize.toml — added the same constraints as persistent_facts so the skill carries them throughout the whole workflow run

Testing

Load the bmad-agent-dev agent and run a story implementation — the generated code should no longer contain epic/story comment references or verbose AI noise.

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
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b7b61e2a-801f-4f72-8b09-15cb8bcc103b

📥 Commits

Reviewing files that changed from the base of the PR and between e772c42 and 3c1d698.

📒 Files selected for processing (2)
  • src/bmm-skills/4-implementation/bmad-agent-dev/customize.toml
  • src/bmm-skills/4-implementation/bmad-dev-story/customize.toml

📝 Walkthrough

Walkthrough

Two 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.

Changes

Comment style constraints

Layer / File(s) Summary
Add comment/production-readiness constraints
src/bmm-skills/4-implementation/bmad-agent-dev/customize.toml, src/bmm-skills/4-implementation/bmad-dev-story/customize.toml
Appends three new rules to each config: no epic/story references in inline comments, comments must explain rationale not process, and generated code must be production-ready without AI noise.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Related issues: #2538 (bmad-dev agent & bmad-dev-story: Excessive noise in generated code)

Suggested labels: documentation, configuration

Suggested reviewers: N/A

Poem:

A hop, a skip, no story tags in sight,
Comments now explain the "why," not the "what" so trite,
Clean code hops forward, production-ready and bright,
This rabbit nibbles noise away, and leaves it out of sight. 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the PR's main change: reducing epic/story comments and AI-generated noise in generated code.
Description check ✅ Passed The description matches the code changes and explains the comment-noise constraints added to both customize.toml files.
Linked Issues check ✅ Passed The changes satisfy #2538 by preventing epic/story metadata comments, favoring rationale-only comments, and requiring production-ready output.
Out of Scope Changes check ✅ Passed The PR is narrowly scoped to two TOML config updates and shows no unrelated code changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@alexeyv

alexeyv commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

Directionally, I like this. But!

  • It should target quick dev and dev auto skills. Dev story is going away soon.
  • Specific defaults feel over-prompted. You can probably express it in two statements: "why not what" and "no referring to planning artifacts, code is truth, and those are transient".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bmad-dev agent & bmad-dev-story: Excessive noise in generated code (epic/story comments, AI slop)

2 participants