Skip to content

refactor(skill): flatten advanced-elicitation by inlining workflow#2076

Merged
alexeyv merged 2 commits intomainfrom
flatten-advanced-elicitation
Mar 20, 2026
Merged

refactor(skill): flatten advanced-elicitation by inlining workflow#2076
alexeyv merged 2 commits intomainfrom
flatten-advanced-elicitation

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 20, 2026

Summary

  • Inlines workflow.md content directly into SKILL.md for the bmad-advanced-elicitation skill
  • Merges frontmatter (agent_party variable) into the single file
  • Deletes the now-redundant workflow.md

All relative references (./methods.csv) remain valid. No behavioral change.

Test plan

  • npm run quality passes (all checks green)
  • Adversarial review: no content lost, no broken references
  • Manual: invoke /bmad-advanced-elicitation and verify it loads correctly

🤖 Generated with Claude Code

alexeyv and others added 2 commits March 20, 2026 10:53
…to SKILL.md

Merge workflow.md content directly into SKILL.md and delete the
now-redundant workflow file.  The frontmatter `agent_party` variable
moves into SKILL.md; all relative file references (`./methods.csv`)
remain valid.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

The PR consolidates the advanced elicitation workflow from a separate workflow.md file into the SKILL.md file. It adds an agent_party frontmatter reference pointing to an agent manifest configuration and replaces minimal instructions with a detailed three-step specification for method selection, interactive menu presentation, and response handling.

Changes

Cohort / File(s) Summary
Advanced Elicitation Skill
src/core-skills/bmad-advanced-elicitation/SKILL.md, src/core-skills/bmad-advanced-elicitation/workflow.md
Consolidated workflow specification from workflow.md into SKILL.md with added agent_party frontmatter; replaced single-line instruction with detailed three-step ordered flow (load methods and agent manifest, perform smart method selection, present interactive options menu with response handling); deleted workflow.md.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • BMAD-METHOD#1840: Modifies configuration for the same bmad-advanced-elicitation skill and adds workflow manifest entries.
  • BMAD-METHOD#1943: Converts workflow-style content into native skill packaging by replacing workflow.md with SKILL.md and updating frontmatter metadata.
  • BMAD-METHOD#1868: Globally refactors installer and tests to use SKILL.md instead of workflow.md as the skill entrypoint.

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'refactor(skill): flatten advanced-elicitation by inlining workflow' accurately describes the main change—consolidating workflow.md content into SKILL.md.
Description check ✅ Passed The description clearly explains the refactoring goal, details what was changed (inlining workflow content, merging frontmatter, deleting redundant file), and confirms no behavioral changes.
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
  • Commit unit tests in branch flatten-advanced-elicitation

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.

🧹 Nitpick comments (1)
src/core-skills/bmad-advanced-elicitation/SKILL.md (1)

30-30: Consider simplifying "return back" to just "return".

Lines 30 and 101 use "return back," which is stylistically redundant. The phrase works but can be streamlined.

✨ Proposed simplification

Line 30:

-3. Return the enhanced version back when user selects 'x' to proceed and return back
+3. Return the enhanced version when user selects 'x' to proceed

Line 101:

-- Return the fully enhanced content back to the invoking skill
+- Return the fully enhanced content to the invoking skill

Also applies to: 101-101

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/core-skills/bmad-advanced-elicitation/SKILL.md` at line 30, The phrase
"return back" in SKILL.md is stylistically redundant; update both occurrences
(the sentence "Return the enhanced version back when user selects 'x' to proceed
and return back" and the occurrence around line 101) to use "return" (e.g.,
"Return the enhanced version when the user selects 'x' to proceed") so the
wording is concise and consistent; search for the exact phrase "return back" in
SKILL.md and replace with "return" while preserving surrounding context and
punctuation.
🤖 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/core-skills/bmad-advanced-elicitation/SKILL.md`:
- Line 30: The phrase "return back" in SKILL.md is stylistically redundant;
update both occurrences (the sentence "Return the enhanced version back when
user selects 'x' to proceed and return back" and the occurrence around line 101)
to use "return" (e.g., "Return the enhanced version when the user selects 'x' to
proceed") so the wording is concise and consistent; search for the exact phrase
"return back" in SKILL.md and replace with "return" while preserving surrounding
context and punctuation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 44e737bd-eea3-4096-8729-8fa63c596dfe

📥 Commits

Reviewing files that changed from the base of the PR and between 4b23892 and 5898b5b.

📒 Files selected for processing (2)
  • src/core-skills/bmad-advanced-elicitation/SKILL.md
  • src/core-skills/bmad-advanced-elicitation/workflow.md
💤 Files with no reviewable changes (1)
  • src/core-skills/bmad-advanced-elicitation/workflow.md

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 20, 2026

🤖 Augment PR Summary

Summary: This PR refactors the bmad-advanced-elicitation skill by collapsing the separate workflow file into a single entrypoint.

Changes:

  • Moves the full workflow content from workflow.md directly into SKILL.md so the skill is self-contained.
  • Migrates the agent_party frontmatter variable into SKILL.md alongside name and description.
  • Replaces the old “Follow the instructions in ./workflow.md” stub with the full Advanced Elicitation flow (method loading, option menu, response handling, execution guidelines).
  • Deletes the now-redundant workflow.md file.

Technical Notes: Relative references (e.g., ./methods.csv) remain local to the skill directory; the refactor primarily reduces indirection by removing an extra file load step.

🤖 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. 5 suggestions posted.

Fix All in Augment

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

- DO NOT skip steps or change the sequence
- HALT immediately when halt-conditions are met
- Each action within a step is a REQUIRED action to complete that step
- Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This line references “validation, output, critical-context” sections, but those sections don’t exist in this SKILL.md; that can confuse execution because it asks the agent to apply missing guidance.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

```
**Advanced Elicitation Options**
_If party mode is active, agents will join in._
Choose a number (1-5), [r] to Reshuffle, [a] List All, or [x] to Proceed:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

After presenting this menu, consider adding an explicit HALT/“wait for user response” instruction; otherwise the agent may continue execution without actually waiting for a selection.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

- Display the enhanced version showing what the method revealed or improved
- **CRITICAL:** Ask the user if they would like to apply the changes to the doc (y/n/other) and HALT to await response.
- **CRITICAL:** ONLY if Yes, apply the changes. IF No, discard your memory of the proposed changes. If any other reply, try best to follow the instructions given by the user.
- **CRITICAL:** Re-present the same 1-5,r,x prompt to allow additional elicitations
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This says to re-present the “1-5,r,x” prompt, but the menu also offers [a] List All; the mismatch can cause the agent to stop offering the full set of options after the first cycle.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

**Case a (List All):**

- List all methods with their descriptions from the CSV in a compact table
- Allow user to select any method by name or number from the full list
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

In the “List All” path, users can select any method “by name or number from the full list”, but the response handling only defines numbered selection for 1–5; clarifying how to handle numbers beyond 5 would prevent ambiguous behavior.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


**Case: Multiple Numbers:**

- Execute methods in sequence on the content, then re-offer choices
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

“Execute methods in sequence” for multiple-number input seems to bypass the earlier per-method confirm-and-HALT requirement; without clarifying the confirmation behavior here, the skill may apply multiple changes without the intended user acceptance gate.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@alexeyv alexeyv merged commit 9725b0a into main Mar 20, 2026
5 checks passed
@alexeyv alexeyv deleted the flatten-advanced-elicitation branch March 20, 2026 17:08
alexeyv added a commit that referenced this pull request Mar 20, 2026
…SKILL.md

Inline workflow.md content directly into SKILL.md for: editorial-review-prose,
editorial-review-structure, help, index-docs, review-adversarial-general,
review-edge-case-hunter, and shard-doc. Deletes the now-redundant workflow.md
files. No behavioral change — same pattern as advanced-elicitation in PR #2076.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
alexeyv added a commit that referenced this pull request Mar 20, 2026
…SKILL.md

Inline workflow.md content directly into SKILL.md for: editorial-review-prose,
editorial-review-structure, help, index-docs, review-adversarial-general,
review-edge-case-hunter, and shard-doc. Deletes the now-redundant workflow.md
files. No behavioral change — same pattern as advanced-elicitation in PR #2076.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
alexeyv added a commit that referenced this pull request Mar 20, 2026
…SKILL.md (#2077)

Inline workflow.md content directly into SKILL.md for: editorial-review-prose,
editorial-review-structure, help, index-docs, review-adversarial-general,
review-edge-case-hunter, and shard-doc. Deletes the now-redundant workflow.md
files. No behavioral change — same pattern as advanced-elicitation in PR #2076.

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
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