Skip to content

fix(quick-dev): correct commit ordering, add loopback directive, fix typo#1876

Merged
alexeyv merged 2 commits intobmad-code-org:mainfrom
alexeyv:fix/quick-dev-preview-tweaks
Mar 11, 2026
Merged

fix(quick-dev): correct commit ordering, add loopback directive, fix typo#1876
alexeyv merged 2 commits intobmad-code-org:mainfrom
alexeyv:fix/quick-dev-preview-tweaks

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 9, 2026

Summary

  • step-05-present: Swap commit/status ordering so the commit captures done status instead of leaving it uncommitted
  • step-04-review: Add explicit read fully and follow directive to intent_gap loopback, matching the pattern already used by bad_spec
  • SKILL.md: Fix missing apostrophe in description (projects -> project's)

Test plan

  • Verify YAML frontmatter in SKILL.md parses correctly (apostrophe escaped)
  • Confirm step-05 sets status before committing
  • Confirm step-04 intent_gap handler has navigation directive

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 9, 2026

📝 Walkthrough

Walkthrough

Updates 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

Cohort / File(s) Summary
Workflow Documentation
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md
Front-matter description string updated to escape apostrophe character.
Workflow Steps
src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md, src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md
step-04-review: Added "reject" category to decision flow with "Drop silently." behavior; updated intent_gap handling instructions. step-05-present: Reordered workflow steps to perform spec file status update before local commit.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • PR #1857: Modifies the same step-04-review.md file with decision flow updates.
  • PR #1868: Modifies the same SKILL.md file, establishing it as the canonical skill entrypoint.

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes all three main changes: commit ordering in step-05, loopback directive in step-04, and typo fix in SKILL.md.
Description check ✅ Passed The description clearly relates to the changeset, detailing specific fixes across three files with a structured test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and split. 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

📥 Commits

Reviewing files that changed from the base of the PR and between 956c43f and 2c3387d.

📒 Files selected for processing (3)
  • src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md
  • src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md
  • src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 9, 2026

🤖 Augment PR Summary

Summary: Updates the bmad-quick-dev-new-preview workflow docs to ensure the spec’s done status is captured in the final commit and to make intent-gap loopbacks explicitly rerun planning.

Changes: Reorders step-05 status/commit instructions, adds a “read fully and follow” directive for the intent_gap loopback in step-04, and fixes YAML-escaped apostrophe wording in SKILL.md.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

alexeyv and others added 2 commits March 11, 2026 11:08
…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>
@alexeyv alexeyv force-pushed the fix/quick-dev-preview-tweaks branch from 2c3387d to dcaedff Compare March 11, 2026 17:08
@alexeyv alexeyv merged commit 874ae40 into bmad-code-org:main Mar 11, 2026
5 checks passed
@alexeyv alexeyv deleted the fix/quick-dev-preview-tweaks branch March 11, 2026 17:35
@alexeyv
Copy link
Copy Markdown
Collaborator Author

alexeyv commented Mar 11, 2026

Nitpick responses:

F3 (double quotes for apostrophe escaping) — DISMISS. The '' escaping is correct YAML syntax and matches the project-wide single-quote convention. Double quotes are not inherently safer.

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.

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.

1 participant