fix(quick-dev): correct commit ordering, add loopback directive, fix typo#1876
Conversation
📝 WalkthroughWalkthroughUpdates to workflow documentation files within the bmad-quick-dev-new-preview workflow, including front-matter syntax correction, addition of a new "reject" category to the decision flow, and reordering of step instructions to ensure frontmatter updates occur before VCS commits. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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.
Actionable comments posted: 2
🧹 Nitpick comments (2)
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md (2)
3-3: Consider double quotes to eliminate escaping fragility.The single-quoted YAML string requires
''to escape the embedded apostrophe. This is technically correct but error-prone — any future edits that add apostrophes must remember the doubling rule. Using double quotes (description: "... project's existing...") would eliminate this escaping requirement and reduce maintenance risk.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md` at line 3, The YAML description value uses single quotes and escapes the apostrophe by doubling (description: 'Implements ... project''s ...'), which is fragile; change the value to use double quotes (description: "Implements any user intent, requirement, story, bug fix or change request by producing clean working code artifacts that follow the project's existing architecture, patterns and conventions. Use when the user wants to build, fix, tweak, refactor, add or modify any code, component or feature.") so the embedded apostrophe in "project's" does not require escaping and future edits are less error-prone; update the description string in SKILL.md accordingly.
3-3: Description verb list is incomplete.The description lists "build, fix, tweak, refactor, add or modify" but omits common operations like
delete,rename,move,extract, andsplit. If those operations are within scope, the description undersells the skill's capability. If they're out of scope, the description should say so explicitly to prevent misuse.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md` at line 3, Update the description field (the description: '...' entry) in SKILL.md to either expand the verb list to include omitted operations such as delete, rename, move, extract, and split (e.g., "...build, fix, tweak, refactor, add, modify, delete, rename, move, extract, split...") or explicitly state which operations are out of scope; ensure the revised sentence preserves existing phrasing and punctuation and clearly documents the full scope or exclusions of the skill.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md`:
- Line 16: Replace the vague "tree is dirty" commit instruction with an explicit
staging step that scopes the commit to only the workflow's output files (e.g.,
stage the story output files or a defined file set/pattern) so the frontmatter
change on line 15 is guaranteed to be included; update the step to first run a
staging command for the intended artifacts (or list the exact file
paths/patterns to stage) and then create the local commit with the conventional
message derived from the spec title (do not commit unstaged/unrelated changes).
- Around line 15-16: The frontmatter change that sets the `{spec_file}` status
to `done` should be reverted so the artifact remains in a review/presented state
(e.g., `in_review` or `presented`) until explicit human approval is received;
update the logic in this step (step-05-present.md) to avoid marking
`{spec_file}` as `done` and to skip creating the local commit with the
conventional message unless an approval signal is received later (or a dedicated
"finalize" step runs), ensuring resumable routing won't treat the spec as
completed before the user accepts it.
---
Nitpick comments:
In `@src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md`:
- Line 3: The YAML description value uses single quotes and escapes the
apostrophe by doubling (description: 'Implements ... project''s ...'), which is
fragile; change the value to use double quotes (description: "Implements any
user intent, requirement, story, bug fix or change request by producing clean
working code artifacts that follow the project's existing architecture, patterns
and conventions. Use when the user wants to build, fix, tweak, refactor, add or
modify any code, component or feature.") so the embedded apostrophe in
"project's" does not require escaping and future edits are less error-prone;
update the description string in SKILL.md accordingly.
- Line 3: Update the description field (the description: '...' entry) in
SKILL.md to either expand the verb list to include omitted operations such as
delete, rename, move, extract, and split (e.g., "...build, fix, tweak, refactor,
add, modify, delete, rename, move, extract, split...") or explicitly state which
operations are out of scope; ensure the revised sentence preserves existing
phrasing and punctuation and clearly documents the full scope or exclusions of
the skill.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 20bf8a2b-3f78-4b17-b220-446cd597473f
📒 Files selected for processing (3)
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.mdsrc/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.mdsrc/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md
Show resolved
Hide resolved
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md
Show resolved
Hide resolved
🤖 Augment PR SummarySummary: Updates the bmad-quick-dev-new-preview workflow docs to ensure the spec’s 🤖 Was this summary useful? React with 👍 or 👎 |
…typo - step-05: set spec status to done before committing so the commit captures the final state - step-04: add explicit read-and-follow directive to intent_gap loopback matching the pattern used by bad_spec - SKILL.md: fix missing apostrophe in description
The review step (step-04) had a bare "4. Commit." line that conflicted with commit responsibility belonging solely to step-05-present. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2c3387d to
dcaedff
Compare
|
Nitpick responses: F3 (double quotes for apostrophe escaping) — DISMISS. The F4 (incomplete verb list) — REJECT. The description already says "any user intent... or change request" and "modify any code, component or feature" which subsumes delete/rename/move/extract/split. The verb list is matching hints, not a capability boundary. |
Summary
donestatus instead of leaving it uncommittedread fully and followdirective tointent_gaploopback, matching the pattern already used bybad_specprojects->project's)Test plan