SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场skill-contributor

skill-contributor

编程与开发

查看项目

更新于 10-16 04:38

技能介绍

用途

Skill Contributor 用于指导贡献者向 claude-code-skills 仓库添加新技能。它帮助用户按照正确的工作流程完成贡献，包括验证和文档更新。

何时使用

在以下情况下使用此技能：

  • 用户想要向 claude-code-skills 仓库贡献新技能
  • 用户要求通过 PR 或 pull request 提交技能
  • 用户请求帮助将其技能添加到仓库
  • 用户提到要为技能集合做出贡献

前置条件检查

开始之前，请验证：

  • 当前工作目录：必须是 claude-code-skills 仓库根目录。运行 pwd 确认，应看到 /path/to/claude-code-skills
  • Git 仓库状态：检查是 fork 还是主仓库。运行 git remote -v。如果是用户的 fork，可以继续；如果是主仓库，引导用户先 fork
  • 新技能已存在：要贡献的技能必须已经创建。询问用户技能目录路径，验证该目录中存在 SKILL.md

贡献工作流程

按照以下步骤指导贡献者：

第 1 步：验证 Fork

检查用户是否已 fork 仓库：git remote -v

  • 如果指向 WomenDefiningAI/claude-code-skills：引导用户在 https://github.com/WomenDefiningAI/claude-code-skills fork 仓库，请他们克隆自己的 fork 并在那里工作
  • 如果指向用户的 fork：继续下一步

第 2 步：将技能复制到仓库

如果技能尚未在仓库中：

  • 询问用户技能目录位置
  • 验证技能结构：ls -la /path/to/their/skill/
  • 将技能复制到 skills/ 目录：cp -r /path/to/their/skill/ ./skills/skill-name/

第 3 步：运行验证

使用验证脚本验证技能结构：

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

如果验证失败：向用户显示错误，提供帮助修复问题，修复后重新运行验证。如果验证通过：继续下一步。

第 4 步：更新 README.md

必须将技能添加到 README.md 的 "Available Skills" 部分。

  • 读取当前 README.md 找到插入点
  • 询问用户：技能名称（显示名称）、一行描述、关键特性（3-5 个要点）
  • 在现有技能之后添加技能条目，格式如下：
### 🎯 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/


- 插入到 "## Available Skills" 部分（在现有技能之后）

### 第 5 步：为技能创建 README.md

如果技能没有 README.md，创建一个：

- 询问用户：技能做什么、安装说明（已标准化）、使用示例、要求/依赖
- 基于 skills/skill-builder/README.md 模板创建 README.md

### 第 6 步：Git 操作

创建新分支并提交更改：

```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

第 7 步：创建 Pull Request

使用 GitHub CLI 创建 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
)"

如果 gh CLI 不可用：手动提供 PR URL：https://github.com/WomenDefiningAI/claude-code-skills/compare，给用户格式化好的 PR 标题和描述以复制。

第 8 步：PR 后检查清单

创建 PR 后，提醒用户：

  • ✅ 验证通过
  • ✅ README.md 已更新
  • ✅ PR 已创建并带有详细描述
  • ⏳ 等待维护者审查
  • 📝 准备好处理反馈

常见问题与解决方案

问题：验证失败

  • 错误："Invalid YAML frontmatter"。修复：检查 SKILL.md 以 --- 开头并具有有效的 YAML
  • 错误："name contains invalid characters"。修复：名称必须为小写、字母数字、仅连字符
  • 错误："Referenced file does not exist"。修复：确保 SKILL.md 中提到的所有文件都存在

问题：用户尚未 Fork

解决方案：引导至 https://github.com/WomenDefiningAI/claude-code-skills，点击 "Fork" 按钮，克隆其 fork，重新开始贡献工作流程。

问题：技能尚未创建

解决方案：先使用 skill-builder 技能创建技能，技能构建完成后再回到 skill-contributor。

验证检查清单

创建 PR 之前，验证：

  • 技能具有 SKILL.md 且包含有效的 YAML frontmatter
  • 技能名称遵循命名规则（小写、连字符、字母数字）
  • 描述清晰且少于 1024 个字符
  • 验证脚本通过：python3 skills/skill-builder/scripts/validate-skill.py skills/skill-name/
  • README.md 已更新并包含技能条目
  • 技能目录位于 skills/ 目录中
  • 所有引用的文件都存在
  • 技能已在本地测试

示例

示例 1：贡献代码审查技能

用户：我创建了一个代码审查技能，想将其贡献到仓库。 助手：我将帮助您将代码审查技能贡献到仓库。让我先检查当前目录和仓库状态。

  1. 检查工作目录和 git remote
  2. 定位 code-review 技能文件
  3. 运行验证
  4. 更新 README.md
  5. 创建带有适当描述的 PR

示例 2：快速贡献

用户：通过 PR 添加我的 test-generator 技能。 助手：我将指导您完成贡献工作流程：

  1. 验证 fork 状态
  2. 验证 test-generator 技能
  3. 更新 README.md
  4. 创建并推送分支
  5. 提交 PR

让我先检查您的仓库设置。

注意事项

  • 创建 PR 前始终运行验证
  • 如果尚未 fork 仓库，请先 fork
  • 更新 README.md 以列出新技能
  • 提供带有验证输出的清晰 PR 描述
  • 对维护者的反馈保持响应
  • 提交前在本地测试技能