agentleFS
WomenDefiningAIWomenDefiningAI/claude-code-skills/skills/skill-contributor/SKILL.md

skill-contributor

Skill10 starsChanged 13 months agoMITView on GitHub

Guides contributors through adding new skills to the claude-code-skills repository via Pull Request with proper validation and documentation

  • Commits and pushes

The file

Show its rules and text

We split this skill into the rules it gives an agent

29 rules. About 0 are common, 23 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈23

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill when:

    line 12
  2. Very specific:

    Current working directory: Must be the claude-code-skills repository root

    line 22
  3. Very specific:

    Run: pwd to confirm

    line 23
  4. Distinctive:

    Git repository status: Check if fork or main repo

    line 26
  5. Distinctive:

    If user's fork: ready to proceed

    line 28
  6. Distinctive:

    If main repo: guide user to fork first

    line 29
  7. Distinctive:

    Ask user for the skill directory path

    line 32
  8. Very specific:

    Verify SKILL.md exists in that directory

    line 33
  9. Distinctive:

    Follow these steps to guide the contributor:

    line 37
  10. Distinctive:

    Check if the user has forked the repository:

    line 41
  11. Distinctive:

    Ask them to clone their fork and work from there

    line 49
  12. Distinctive:

    If the skill is not already in the repository:

    line 55
  13. Distinctive:

    Ask user for the skill directory location

    line 57
  14. Distinctive:

    Verify the skill structure:

    line 58
  15. Distinctive:

    Read the current README.md to find the insertion point

    line 86
  16. Distinctive:

    Ask the user for:

    line 87
  17. Distinctive:

    Add the skill entry after the existing skills, following this format:

    line 92
  18. Distinctive:

    If the skill doesn't have a README.md, create one:

    line 121
  19. Very specific:

    Create README.md based on skills/skill-builder/README.md template

    line 129
  20. Distinctive:

    Create a new branch and commit the changes:

    line 133
  21. Distinctive:

    Use GitHub CLI to create the PR:

    line 161
  22. Distinctive:

    After creating the PR, remind the user:

    line 211
  23. Very specific:

    Fix: Check SKILL.md starts with --- and has valid YAML

    line 224
  24. Very specific:

    Fix: Ensure all files mentioned in SKILL.md exist

    line 230
  25. Distinctive:

    Use the skill-builder skill to create the skill first

    line 243
  26. Distinctive:

    Before creating the PR, verify:

    line 248
  27. Distinctive:

    Always run validation before creating PR

    line 290
  28. Distinctive:

    Update README.md to list the new skill

    line 292
  29. Distinctive:

    Test the skill locally before submitting

    line 295

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Skill Contributor

Helps contributors add new skills to the claude-code-skills repository following the proper workflow with validation and documentation updates.

When to Use

Use this skill when:

  • User wants to contribute a new skill to the claude-code-skills repository
  • User asks to submit a skill via PR or pull request
  • User requests help adding their skill to the repository
  • User mentions contributing to the skill collection

Prerequisites Check

Before starting, verify:

  1. Current working directory: Must be the claude-code-skills repository root
    • Run: pwd to confirm
    • Should see: /path/to/claude-code-skills
  2. Git repository status: Check if fork or main repo
    • Run: git remote -v
    • If user's fork: ready to proceed
    • If main repo: guide user to fork first
  3. New skill exists: The skill to contribute must already be created
    • Ask user for the skill directory path
    • Verify SKILL.md exists in that directory

Contribution Workflow

Follow these steps to guide the contributor:

Step 1: Fork Verification

Check if the user has forked the repository:

git remote -v

If pointing to WomenDefiningAI/claude-code-skills:

If pointing to user's fork: Proceed to next step

Step 2: Copy Skill to Repository

If the skill is not already in the repository:

  1. Ask user for the skill directory location
  2. Verify the skill structure:
    ls -la /path/to/their/skill/
  3. Copy skill to the skills/ directory:
    cp -r /path/to/their/skill/ ./skills/skill-name/

Step 3: Run Validation

Validate the skill structure using the validation script:

python3 skills/skill-builder/scripts/validate-skill.py skills/skill-name/

If validation fails:

  • Show the user the errors
  • Offer to help fix issues
  • Re-run validation after fixes

If validation passes: Proceed to next step

Step 4: Update README.md

The skill must be added to the README.md in the "Available Skills" section.

  1. Read the current README.md to find the insertion point
  2. Ask the user for:
    • Skill name (display name)
    • One-line description
    • Key features (3-5 bullet points)
  3. Add the skill entry after the existing skills, following this format:
### 🎯 Skill Display Name

**Status**: ✅ Available
**Directory**: `skills/skill-name/`
**Purpose**: One-line description of the skill

**Features**:
- Feature 1
- Feature 2
- Feature 3

[**View Documentation →**](skills/skill-name/README.md)

**Quick Install**:
```bash
git clone https://github.com/WomenDefiningAI/claude-code-skills.git
cp -r claude-code-skills/skills/skill-name ~/.claude/skills/


4. Insert in the "## Available Skills" section (after existing skills)

### Step 5: Create README.md for the Skill

If the skill doesn't have a README.md, create one:

1. Ask user for:
   - What the skill does
   - Installation instructions (already standardized)
   - Usage examples
   - Requirements/dependencies

2. Create README.md based on skills/skill-builder/README.md template

### Step 6: Git Operations

Create a new branch and commit the changes:

```bash
# Create feature branch
git checkout -b add-skill-name

# Add the new skill
git add skills/skill-name/

# Add updated README
git add README.md

# Create commit
git commit -m "Add [skill-name] skill

- Adds new skill: [brief description]
- Includes validation
- Updates README.md with skill documentation

🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>"

# Push to user's fork
git push -u origin add-skill-name

Step 7: Create Pull Request

Use GitHub CLI to create the PR:

gh pr create --title "Add [skill-name] skill" --body "$(cat <<'EOF'
## Summary

This PR adds a new skill: **[skill-name]**

### What This Skill Does

[Brief description of what the skill does and when to use it]

### Changes Included

- ✅ New skill directory: `skills/skill-name/`
- ✅ SKILL.md with valid frontmatter
- ✅ README.md with installation and usage instructions
- ✅ Updated main README.md to list the skill
- ✅ Passed validation: `python3 skills/skill-builder/scripts/validate-skill.py skills/skill-name/`

### Validation Output

[Paste validation output showing ✅ VALIDATION PASSED]


### Testing

Tested by:
- [ ] Installing to `~/.claude/skills/` directory
- [ ] Verifying Claude recognizes the skill
- [ ] Testing the skill with example use cases

### Additional Notes

[Any additional context, dependencies, or notes for reviewers]

---

🤖 Generated with [Claude Code](https://claude.com/claude-code)
EOF
)"

If gh CLI not available:

Step 8: Post-PR Checklist

After creating the PR, remind the user:

  1. ✅ Validation passed
  2. ✅ README.md updated
  3. ✅ PR created with detailed description
  4. ⏳ Wait for maintainer review
  5. 📝 Be ready to address feedback

Common Issues & Solutions

Issue: Validation Fails

Error: "Invalid YAML frontmatter"

  • Fix: Check SKILL.md starts with --- and has valid YAML

Error: "name contains invalid characters"

  • Fix: Name must be lowercase, alphanumeric, hyphens only

Error: "Referenced file does not exist"

  • Fix: Ensure all files mentioned in SKILL.md exist

Issue: User Hasn't Forked

Solution:

  1. Direct to https://github.com/WomenDefiningAI/claude-code-skills
  2. Click "Fork" button
  3. Clone their fork
  4. Restart contribution workflow

Issue: Skill Not Created Yet

Solution:

  • Use the skill-builder skill to create the skill first
  • Come back to skill-contributor after skill is built

Validation Checklist

Before creating the PR, verify:

  • Skill has SKILL.md with valid YAML frontmatter
  • Skill name follows naming rules (lowercase, hyphens, alphanumeric)
  • Description is clear and under 1024 characters
  • Validation script passes: python3 skills/skill-builder/scripts/validate-skill.py skills/skill-name/
  • README.md is updated with skill entry
  • Skill directory is in the skills/ directory
  • All referenced files exist
  • Skill has been tested locally

Examples

Example 1: Contributing a Code Review Skill

User: I've created a code review skill and want to contribute it to the repo
Assistant: I'll help you contribute your code review skill to the repository. Let me start by checking the current directory and repository status.

1. Check working directory and git remote
2. Locate the code-review skill files
3. Run validation
4. Update README.md
5. Create PR with proper description

Example 2: Quick Contribution

User: Add my test-generator skill via PR
Assistant: I'll guide you through the contribution workflow:
1. Verify fork status
2. Validate test-generator skill
3. Update README.md
4. Create and push branch
5. Submit PR

Let me start by checking your repository setup.

Notes

  • Always run validation before creating PR
  • Fork the repository if you haven't already
  • Update README.md to list the new skill
  • Provide clear PR description with validation output
  • Be responsive to maintainer feedback
  • Test the skill locally before submitting

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.