fix(skills): add missing name frontmatter for search-first#266
Conversation
📝 WalkthroughWalkthroughAdds a Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 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)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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)
skills/search-first/SKILL.md (1)
1-159: Consider adding an explicit## How It Workssection.The coding guidelines require skills to include sections for "When to Use", "How It Works", and "Examples". The file currently has
## Trigger(covers "When to Use") and## Examples, but no explicit "How It Works" section — the closest analog is## Workflow/## How to Use, which covers the mechanics but doesn't match the required heading. This is a pre-existing gap, not introduced by this PR, but worth addressing.As per coding guidelines: "Skills should be formatted as Markdown with clear sections for When to Use, How It Works, and Examples."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/search-first/SKILL.md` around lines 1 - 159, Add an explicit "## How It Works" section to the search-first SKILL.md that describes the core mechanics of the skill (summarize the 5-step workflow: Need Analysis, Parallel Search, Evaluate, Decide, Implement), include the Decision Matrix mapping signals to actions (Adopt/Extend/Compose/Build) and where to invoke the researcher agent (reference the Task(subagent_type="general-purpose"...) pattern), and place this new section near the existing "## Workflow" / "## How to Use" content so the file explicitly contains "When to Use" (Trigger), "How It Works", and "Examples" headings as required by the coding guidelines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@skills/search-first/SKILL.md`:
- Around line 1-159: Add an explicit "## How It Works" section to the
search-first SKILL.md that describes the core mechanics of the skill (summarize
the 5-step workflow: Need Analysis, Parallel Search, Evaluate, Decide,
Implement), include the Decision Matrix mapping signals to actions
(Adopt/Extend/Compose/Build) and where to invoke the researcher agent (reference
the Task(subagent_type="general-purpose"...) pattern), and place this new
section near the existing "## Workflow" / "## How to Use" content so the file
explicitly contains "When to Use" (Trigger), "How It Works", and "Examples"
headings as required by the coding guidelines.
affaan-m
left a comment
There was a problem hiding this comment.
Automated review: doc-only changes look good. Approving.
fix(search-first): add missing skill name frontmatter (#266)
fix: add missing name frontmatter for search-first skill
fix: add missing name frontmatter for search-first skill
Summary
name: search-firstfrontmatter toskills/search-first/SKILL.mdDescription
Adds the missing
namefield in thesearch-firstskill frontmatter.Type
Type of Change
fix:Bug fixfeat:New featurerefactor:Code refactoringdocs:Documentationtest:Testschore:Maintenance/toolingci:CI/CD changesTesting
node scripts/ci/validate-skills.jsnpm testChecklist
node tests/run-all.js)Summary by CodeRabbit