Skip to content

Fix invalid YAML frontmatter in setup skill template#55

Open
Snow9666 wants to merge 1 commit intobmad-code-org:mainfrom
Snow9666:fix/setup-skill-template-yaml-frontmatter
Open

Fix invalid YAML frontmatter in setup skill template#55
Snow9666 wants to merge 1 commit intobmad-code-org:mainfrom
Snow9666:fix/setup-skill-template-yaml-frontmatter

Conversation

@Snow9666
Copy link
Copy Markdown

@Snow9666 Snow9666 commented Apr 1, 2026

Summary:

  • quote the name placeholder in the setup skill template frontmatter
  • add a regression test to keep the template valid before substitution

Why:
Codex scans every SKILL.md under installed skills. The unquoted placeholder name: { setup-skill-name } is parsed as a YAML map instead of a string, so the template file is skipped as an invalid skill during startup.

Validation:

  • python3 skills/bmad-module-builder/scripts/tests/test-scaffold-setup-skill.py

Summary by CodeRabbit

  • Improvements

    • Skill template metadata formatting now uses quoted placeholder values for more consistent and robust template files, reducing ambiguity in generated content.
  • Tests

    • Added validation to ensure skill template front-matter uses the quoted placeholder format, and included this check in the scaffold test suite.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 59e805c6-e331-4421-a0ba-68527e218e05

📥 Commits

Reviewing files that changed from the base of the PR and between 56467bb and 9b6898a.

📒 Files selected for processing (2)
  • skills/bmad-module-builder/assets/setup-skill-template/SKILL.md
  • skills/bmad-module-builder/scripts/tests/test-scaffold-setup-skill.py
✅ Files skipped from review due to trivial changes (1)
  • skills/bmad-module-builder/assets/setup-skill-template/SKILL.md

Walkthrough

Changed the SKILL.md template front-matter name from an unquoted templated token to a double-quoted templated string (name: "{setup-skill-name}") and added a test that asserts the template contains that exact quoted line.

Changes

Cohort / File(s) Summary
Template Front-Matter Update
skills/bmad-module-builder/assets/setup-skill-template/SKILL.md
Front-matter name formatting changed from name: { setup-skill-name }name: "{setup-skill-name}".
Test Validation
skills/bmad-module-builder/scripts/tests/test-scaffold-setup-skill.py
Added test_template_frontmatter_uses_quoted_name_placeholder and included it in the test list to verify the quoted name placeholder line is present.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related issues

Suggested reviewers

  • bmadcode

Poem

A rabbit hops through YAML fields with glee,
Quoting placeholders for clarity!
"{setup-skill-name}" now wrapped up tight,
Tests hop along to verify the sight! 🐰✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing invalid YAML frontmatter in the setup skill template by quoting the name placeholder.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

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

@dickymoore
Copy link
Copy Markdown

Good stuff @Snow9666. I closed my duplicate PR #57 since this one came first.

@Snow9666 Snow9666 marked this pull request as draft April 4, 2026 12:30
@Snow9666 Snow9666 marked this pull request as ready for review April 4, 2026 12:30
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.

2 participants