Optimize directory structure: Move SKILL.md to dedicated skills directory - #8
Open
WhizZest wants to merge 1 commit into
Open
Optimize directory structure: Move SKILL.md to dedicated skills directory#8WhizZest wants to merge 1 commit into
WhizZest wants to merge 1 commit into
Conversation
… folder, because installing skill only requires the SKILL.md file.
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.
PR Document - Optimize directory structure: Move SKILL.md to dedicated skills directory
Title
Optimize directory structure: Move SKILL.md to dedicated skills directory
Description
This commit adjusts the repository directory structure by moving the
SKILL.mdfile from the repository root to theskills/SKILL.mddedicated directory.Type
refactor- Code/directory structure refactoringDetails
Moved the
SKILL.mdfile from the repository root to theskills/SKILL.mddirectory to optimize the AI Agent skills installation workflow.Specific changes:
SKILL.md→skills/SKILL.mdMotivation & Background
Problem Analysis
Redundant Installation Issue: In the original directory structure, when users execute
npx skills add <repo>, the entire repository content is installed locally, including source code, test files, documentation, and many other unnecessary files.Actual Usage Scenario: For AI Agents, installing a skill only requires the
SKILL.mdfile. This file contains complete information including:Practical Verification: Through actual usage testing, it has been verified that AI Agents only need the installation instructions in
SKILL.mdto complete the installation and usage of this CLI tool, without relying on scripts or other files from the repository.Solution
By placing
SKILL.mdin a dedicatedskills/directory, when users executenpx skills add <repo>, the Skills CLI will only install content from theskills/directory, achieving:SKILL.mdfile is installedTesting & Verification
Verification Steps
SKILL.mdfile has been successfully moved toskills/SKILL.mdnpx skills add <repo>command can correctly identify and install the skillReal-world Usage Verification
Through actual demonstration, the following scenarios were verified:
SKILL.mdRelated Issues
None (This is an optimization based on actual usage experience)
Impact Scope
Backward Compatibility
SKILL.mdin theskills/directoryChecklist