fix(create-story): read UPDATE files before generating dev notes#2274
fix(create-story): read UPDATE files before generating dev notes#2274pablontiv wants to merge 1 commit intobmad-code-org:mainfrom
Conversation
When a story modifies existing files, create-story must read those files before generating dev notes. Without this, dev agents improvise design decisions without knowing the current state of the code, leading to regressions caught only at review time. Adds a step at the end of Step 3 (Architecture analysis) that reads every file marked UPDATE in the architecture directory structure and documents its current state, what the story changes, and what must be preserved. Fixes bmad-code-org#2273
📝 WalkthroughWalkthroughThe workflow documentation for Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/bmm-skills/4-implementation/bmad-create-story/workflow.md (1)
278-280: Consider simplifying "whether or not" to "whether".The critical note about end-to-end functionality is an important guardrail. One minor style refinement: line 280's "whether or not" could be shortened to just "whether" for conciseness, unless you specifically want to emphasize "regardless of whether."
✨ Optional style improvement
<critical>A story implementation must leave the system working end-to-end — not just satisfy its stated ACs. - If a behavior is required for the feature to work correctly in the existing system, it is a requirement - whether or not it is explicitly written in the story. The dev agent owns this.</critical> + If a behavior is required for the feature to work correctly in the existing system, it is a requirement + whether it is explicitly written in the story. The dev agent owns this.</critical>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/bmm-skills/4-implementation/bmad-create-story/workflow.md` around lines 278 - 280, Replace the phrase "whether or not" with "whether" in the critical note inside the critical block of workflow.md (the sentence beginning "If a behavior is required for the feature to work correctly..."); update the text in that critical block so it reads "whether it is explicitly written in the story" to improve conciseness, unless you intentionally want the extra emphasis, in which case leave it unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/bmm-skills/4-implementation/bmad-create-story/workflow.md`:
- Around line 278-280: Replace the phrase "whether or not" with "whether" in the
critical note inside the critical block of workflow.md (the sentence beginning
"If a behavior is required for the feature to work correctly..."); update the
text in that critical block so it reads "whether it is explicitly written in the
story" to improve conciseness, unless you intentionally want the extra emphasis,
in which case leave it unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: fafe83a4-2d3e-43c1-a071-d6c7c76655c5
📒 Files selected for processing (1)
src/bmm-skills/4-implementation/bmad-create-story/workflow.md
What
Adds a step at the end of Step 3 (Architecture analysis) in
bmad-create-story/workflow.mdthat reads every file marked UPDATE in the architecture directory structure before generating dev notes.Why
When a story modifies existing files, the dev agent currently has no knowledge of their current state — it only knows planning artifacts. This leads to improvised design decisions at implementation time, which code review then catches as regressions. A story implementation must leave the system working end-to-end, not just satisfy its stated ACs.
How
<critical>block and two<action>items after the existing architecture extractionTesting
Applied locally to a brownfield React Native project. First story using the updated skill correctly read
_layout.tsxbefore generating dev notes, documenting the existing auth guard and share-intent integration that the story needed to preserve.Fixes #2273