1.5 KiB
1.5 KiB
improve-skills
Used when a skill or workflow has one of these problems:
- Misleading or ambiguous
- Missing coverage for your use case
- Suboptimal or confusing behavior
Principle
Improvement is better than workaround. Fix problems when you find them, so others don't hit the same pitfall.
Requirement
All skill-related documentation must be written in English. This applies to:
- Creating new skills or workflows
- Improving or correcting existing skills
- Any other documentation within skills
See
{baseDir}/docs/standard.mdfor skill structure and writing requirements.
Process
1. Identify the Problem
- Record which skill and which part has the issue
- Describe specifically: what's misleading, what's missing, what's not working well
- Record the scenario where you encountered it
2. Assess Impact
- How many people will this affect?
- Is it a design issue or a documentation issue?
- What's the complexity of the fix?
3. Design the Fix
- Documentation issue → update SKILL.md or related descriptions
- Logic flaw → modify the script or skill logic
- Missing coverage → add a new workflow or script
- Process issue → redesign the workflow
4. Implement
- Make changes locally or on a branch
- Update SKILL.md if behavior changed
- Test if the change is significant
5. Submit
- Call
{baseDir}/scripts/promote-improvementsto push to your branch. - Commit message should describe what was changed and why