fix(skill-creator): trim overlong description and remove hardcoded download path#1392
Open
krishyaid-coder wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR resolves two quality issues in
skills/skill-creator/SKILL.md:Description length. The
descriptionfield was 319 characters, exceeding the ~250-character guideline in the best-practices doc. Trimmed to 187 characters while preserving the three core use-cases (create, modify, evaluate). The explicit trigger phrase remains.Hardcoded user path. Line 371 referenced
~/Downloads/eval_set.json, which assumes macOS conventions and that the browser writes to the user's Downloads folder. On Windows and Linux browsers default elsewhere; the exact path also varies per browser and configuration. Reworded to describe the intent without assuming a location, so the guidance stays portable.How I found these
Static analysis with doodle, a small MIT-licensed linter for
SKILL.mdfiles grounded in the failure modes discussed in #267. Findings correspond to thedesc/too-longandbody/absolute-user-pathrules.For context, I ran the same tool across 62 published skills as a validation exercise, and the patterns are common enough that it seemed worth surfacing directly against the reference skill authors will most often study when writing their own. Full report: https://github.com/krishyaid-coder/doodle/blob/main/docs/QUALITY_REPORT.md
Happy to close if the direction isn't wanted, or to split into two commits if a smaller-per-commit unit reviews better. Not attached to the specific wording of either replacement but the goal is just alignment with the documented guidelines.