diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json index 901ed96..29f45c9 100644 --- a/.claude-plugin/marketplace.json +++ b/.claude-plugin/marketplace.json @@ -5,8 +5,8 @@ "email": "daymadev89@gmail.com" }, "metadata": { - "description": "Professional Claude Code skills for GitHub operations, document conversion, diagram generation, statusline customization, Teams communication, repomix utilities, skill creation, CLI demo generation, LLM icon access, Cloudflare troubleshooting, UI design system extraction, professional presentation creation, YouTube video downloading, secure repomix packaging, ASR transcription correction, video comparison quality analysis, comprehensive QA testing infrastructure, prompt optimization with EARS methodology, session history recovery, documentation cleanup, PDF generation with Chinese font support, CLAUDE.md progressive disclosure optimization, CCPM skill registry search and management, Promptfoo LLM evaluation framework, iOS app development with XcodeGen and SwiftUI, fact-checking with automated corrections, Twitter/X content fetching, and intelligent macOS disk space recovery", - "version": "1.21.1", + "description": "Professional Claude Code skills for GitHub operations, document conversion, diagram generation, statusline customization, Teams communication, repomix utilities, skill creation, CLI demo generation, LLM icon access, Cloudflare troubleshooting, UI design system extraction, professional presentation creation, YouTube video downloading, secure repomix packaging, ASR transcription correction, video comparison quality analysis, comprehensive QA testing infrastructure, prompt optimization with EARS methodology, session history recovery, documentation cleanup, PDF generation with Chinese font support, CLAUDE.md progressive disclosure optimization, CCPM skill registry search and management, Promptfoo LLM evaluation framework, iOS app development with XcodeGen and SwiftUI, fact-checking with automated corrections, Twitter/X content fetching, intelligent macOS disk space recovery, skill quality review and improvement, and GitHub contribution strategy", + "version": "1.22.0", "homepage": "https://github.com/daymade/claude-code-skills" }, "plugins": [ @@ -579,6 +579,46 @@ "skills": [ "./macos-cleaner" ] + }, + { + "name": "skill-reviewer", + "description": "Reviews and improves Claude Code skills against official best practices. Supports three modes - self-review (validate your own skills), external review (evaluate others' skills), and auto-PR (fork, improve, submit). Use when checking skill quality, reviewing skill repositories, or contributing improvements to open-source skills", + "source": "./", + "strict": false, + "version": "1.0.0", + "category": "developer-tools", + "keywords": [ + "skill-review", + "best-practices", + "claude-code", + "quality-assurance", + "open-source", + "contribution", + "auto-pr" + ], + "skills": [ + "./skill-reviewer" + ] + }, + { + "name": "github-contributor", + "description": "Strategic guide for becoming an effective GitHub contributor. Covers opportunity discovery, project selection, high-quality PR creation, and reputation building. Use when looking to contribute to open-source projects, building GitHub presence, or learning contribution best practices", + "source": "./", + "strict": false, + "version": "1.0.0", + "category": "developer-tools", + "keywords": [ + "github", + "open-source", + "contribution", + "pull-request", + "reputation", + "contributor", + "oss" + ], + "skills": [ + "./github-contributor" + ] } ] } diff --git a/CHANGELOG.md b/CHANGELOG.md index b400b41..97929c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Security - None +## [1.22.0] - 2026-01-15 + +### Added +- **New Skill**: skill-reviewer - Reviews and improves Claude Code skills against official best practices + - Self-review mode: Validate your own skills before publishing + - External review mode: Evaluate others' skill repositories + - Auto-PR mode: Fork, improve, and submit PRs to external repos + - Automated validation via bundled skill-creator scripts + - Evaluation checklist covering frontmatter, instructions, and resources + - Additive-only contribution principle (never delete files) + - PR guidelines with tone recommendations and templates + - Self-review checklist for respect verification + - References: evaluation_checklist.md, pr_template.md, marketplace_template.json + - Auto-install dependencies: automatically installs skill-creator if missing + +- **New Skill**: github-contributor - Strategic guide for becoming an effective GitHub contributor + - Four contribution types: Documentation, Code Quality, Bug Fixes, Features + - Project selection criteria with red flags + - PR excellence workflow with templates + - Reputation building ladder (Documentation → Bug Fixes → Features → Maintainer) + - GitHub CLI command reference + - Conventional commit message format + - Common mistakes and best practices + - References: pr_checklist.md, project_evaluation.md, communication_templates.md + +### Changed +- Updated marketplace skills count from 28 to 30 +- Updated marketplace version from 1.21.1 to 1.22.0 +- Updated README.md badges (skills count: 30, version: 1.22.0) +- Updated README.md to include skill-reviewer in skills listing +- Updated README.md to include github-contributor in skills listing +- Updated README.zh-CN.md badges (skills count: 30, version: 1.22.0) +- Updated README.zh-CN.md to include skill-reviewer in skills listing +- Updated README.zh-CN.md to include github-contributor in skills listing +- Updated CLAUDE.md skills count from 28 to 30 +- Added skill-reviewer use case section to README.md +- Added github-contributor use case section to README.md +- Added skill-reviewer use case section to README.zh-CN.md +- Added github-contributor use case section to README.zh-CN.md + ## [1.21.1] - 2026-01-11 ### Changed diff --git a/CLAUDE.md b/CLAUDE.md index d19d399..6b97861 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co ## Repository Overview -This is a Claude Code skills marketplace containing 28 production-ready skills organized in a plugin marketplace structure. Each skill is a self-contained package that extends Claude's capabilities with specialized knowledge, workflows, and bundled resources. +This is a Claude Code skills marketplace containing 30 production-ready skills organized in a plugin marketplace structure. Each skill is a self-contained package that extends Claude's capabilities with specialized knowledge, workflows, and bundled resources. **Essential Skill**: `skill-creator` is the most important skill in this marketplace - it's a meta-skill that enables users to create their own skills. Always recommend it first for users interested in extending Claude Code. @@ -134,7 +134,7 @@ Skills for public distribution must NOT contain: ## Marketplace Configuration The marketplace is configured in `.claude-plugin/marketplace.json`: -- Contains 28 plugins, each mapping to one skill +- Contains 30 plugins, each mapping to one skill - Each plugin has: name, description, version, category, keywords, skills array - Marketplace metadata: name, owner, version, homepage @@ -144,7 +144,7 @@ The marketplace is configured in `.claude-plugin/marketplace.json`: 1. **Marketplace Version** (`.claude-plugin/marketplace.json` → `metadata.version`) - Tracks the marketplace catalog as a whole - - Current: v1.20.0 + - Current: v1.22.0 - Bump when: Adding/removing skills, major marketplace restructuring - Semantic versioning: MAJOR.MINOR.PATCH @@ -188,6 +188,8 @@ The marketplace is configured in `.claude-plugin/marketplace.json`: 26. **fact-checker** - Verify factual claims in documents using web search with automated corrections 27. **twitter-reader** - Fetch Twitter/X post content using Jina.ai API without JavaScript or authentication 28. **macos-cleaner** - Intelligent macOS disk space analysis and cleanup with safety-first philosophy, risk categorization, and interactive confirmation +29. **skill-reviewer** - Reviews and improves Claude Code skills against official best practices with self-review, external review, and auto-PR modes +30. **github-contributor** - Strategic guide for becoming an effective GitHub contributor with opportunity discovery, project selection, and reputation building **Recommendation**: Always suggest `skill-creator` first for users interested in creating skills or extending Claude Code. diff --git a/README.md b/README.md index 7aba0a4..75c6b42 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ [![简体中文](https://img.shields.io/badge/语言-简体中文-red)](./README.zh-CN.md) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![Skills](https://img.shields.io/badge/skills-28-blue.svg)](https://github.com/daymade/claude-code-skills) -[![Version](https://img.shields.io/badge/version-1.21.0-green.svg)](https://github.com/daymade/claude-code-skills) +[![Skills](https://img.shields.io/badge/skills-30-blue.svg)](https://github.com/daymade/claude-code-skills) +[![Version](https://img.shields.io/badge/version-1.22.0-green.svg)](https://github.com/daymade/claude-code-skills) [![Claude Code](https://img.shields.io/badge/Claude%20Code-2.0.13+-purple.svg)](https://claude.com/code) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/daymade/claude-code-skills/graphs/commit-activity) -Professional Claude Code skills marketplace featuring 28 production-ready skills for enhanced development workflows. +Professional Claude Code skills marketplace featuring 30 production-ready skills for enhanced development workflows. ## 📑 Table of Contents @@ -216,6 +216,12 @@ claude plugin install iOS-APP-developer@daymade-skills # Twitter/X content fetching claude plugin install twitter-reader@daymade-skills + +# Skill quality review and improvement +claude plugin install skill-reviewer@daymade-skills + +# GitHub contribution strategy +claude plugin install github-contributor@daymade-skills ``` Each skill can be installed independently - choose only what you need! @@ -1147,6 +1153,108 @@ Recommendation: Start with 🟢 Safe items (95 GB), then review 🟡 items toget --- +### 27. **skill-reviewer** - Skill Quality Review & Improvement + +Review and improve Claude Code skills against official best practices with three powerful modes. + +**When to use:** +- Validating your own skills before publishing +- Evaluating others' skill repositories +- Contributing improvements to open-source skills via auto-PR +- Ensuring skills follow marketplace standards + +**Key features:** +- **Self-review mode**: Run automated validation via skill-creator scripts +- **External review mode**: Clone, analyze, and generate improvement reports +- **Auto-PR mode**: Fork → improve → submit PR with additive-only changes +- **Evaluation checklist**: Frontmatter, instructions, resources verification +- **Additive-only principle**: Never delete files when contributing to others +- **PR guidelines**: Tone recommendations and professional templates +- **Auto-install dependencies**: Automatically installs skill-creator if missing + +**Example usage:** +```bash +# Install the skill +claude plugin install skill-reviewer@daymade-skills + +# Self-review your skill +"Validate my skill at ~/my-skills/my-awesome-skill" + +# Review external skill repository +"Review the skills at https://github.com/user/skill-repo" + +# Auto-PR improvements +"Fork, improve, and submit PR for https://github.com/user/skill-repo" +``` + +**🎬 Live Demo** + +*Coming soon* + +📚 **Documentation**: See [skill-reviewer/references/](./skill-reviewer/references/) for: +- `evaluation_checklist.md` - Complete skill evaluation criteria +- `pr_template.md` - Professional PR description template +- `marketplace_template.json` - Marketplace configuration template + +--- + +### 28. **github-contributor** - GitHub Contribution Strategy + +Strategic guide for becoming an effective GitHub contributor and building your open-source reputation. + +**When to use:** +- Looking for projects to contribute to +- Learning contribution best practices +- Building your GitHub presence and reputation +- Understanding how to write high-quality PRs + +**Key features:** +- **Four contribution types**: Documentation, Code Quality, Bug Fixes, Features +- **Project selection criteria**: What makes a good first project vs red flags +- **PR excellence workflow**: Before → During → After submission checklist +- **Reputation building ladder**: Documentation → Bug Fixes → Features → Maintainer +- **GitHub CLI commands**: Quick reference for fork, PR, issue operations +- **Conventional commit format**: Type, scope, description structure +- **Common mistakes**: What to avoid and best practices + +**Contribution types explained:** +``` +Level 1: Documentation fixes (lowest barrier, high impact) + ↓ (build familiarity) +Level 2: Code quality (medium effort, demonstrates skill) + ↓ (understand codebase) +Level 3: Bug fixes (high impact, builds trust) + ↓ (trusted contributor) +Level 4: Feature additions (highest visibility) + ↓ (potential maintainer) +``` + +**Example usage:** +```bash +# Install the skill +claude plugin install github-contributor@daymade-skills + +# Find good first issues +"Help me find projects with good first issues in Python" + +# Write a high-quality PR +"Guide me through creating a PR for this bug fix" + +# Build contribution strategy +"Help me plan a contribution strategy for building my GitHub profile" +``` + +**🎬 Live Demo** + +*Coming soon* + +📚 **Documentation**: See [github-contributor/references/](./github-contributor/references/) for: +- `pr_checklist.md` - Complete PR quality checklist +- `project_evaluation.md` - How to evaluate projects for contribution +- `communication_templates.md` - Issue and PR communication templates + +--- + ## 🎬 Interactive Demo Gallery Want to see all demos in one place with click-to-enlarge functionality? Check out our [interactive demo gallery](./demos/index.html) or browse the [demos directory](./demos/). @@ -1213,6 +1321,9 @@ Use **macos-cleaner** to intelligently analyze and reclaim disk space on macOS w ### For Twitter/X Content Research Use **twitter-reader** to fetch tweet content without JavaScript rendering or authentication. Perfect for documenting social media discussions, archiving threads, analyzing tweet content, or gathering reference material from Twitter/X. Combine with **markdown-tools** to convert fetched content into other formats, or with **repomix-safe-mixer** to package research collections securely. +### For Skill Quality & Open-Source Contributions +Use **skill-reviewer** to validate your own skills against best practices before publishing, or to review and improve others' skill repositories. Combine with **github-contributor** to find high-impact open-source projects, create professional PRs, and build your contributor reputation. Perfect for developers who want to contribute to the Claude Code ecosystem or any GitHub project systematically. + ## 📚 Documentation Each skill includes: @@ -1250,6 +1361,8 @@ Each skill includes: - **iOS-APP-developer**: See `iOS-APP-developer/references/xcodegen-full.md` for XcodeGen options and project.yml details - **twitter-reader**: See `twitter-reader/SKILL.md` for API key setup and URL format support - **macos-cleaner**: See `macos-cleaner/references/cleanup_targets.md` for detailed cleanup target explanations, `macos-cleaner/references/mole_integration.md` for Mole visual tool integration, and `macos-cleaner/references/safety_rules.md` for comprehensive safety guidelines +- **skill-reviewer**: See `skill-reviewer/references/evaluation_checklist.md` for complete evaluation criteria, `skill-reviewer/references/pr_template.md` for PR templates, and `skill-reviewer/references/marketplace_template.json` for marketplace configuration +- **github-contributor**: See `github-contributor/references/pr_checklist.md` for PR quality checklist, `github-contributor/references/project_evaluation.md` for project evaluation criteria, and `github-contributor/references/communication_templates.md` for issue/PR templates ## 🛠️ Requirements @@ -1354,4 +1467,4 @@ If you find these skills useful, please: **Built with ❤️ using the skill-creator skill for Claude Code** -Last updated: 2025-12-20 | Marketplace version 1.18.0 +Last updated: 2026-01-15 | Marketplace version 1.22.0 diff --git a/README.zh-CN.md b/README.zh-CN.md index 988d582..9b82e41 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -6,15 +6,15 @@ [![简体中文](https://img.shields.io/badge/语言-简体中文-red)](./README.zh-CN.md) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![Skills](https://img.shields.io/badge/skills-28-blue.svg)](https://github.com/daymade/claude-code-skills) -[![Version](https://img.shields.io/badge/version-1.21.0-green.svg)](https://github.com/daymade/claude-code-skills) +[![Skills](https://img.shields.io/badge/skills-30-blue.svg)](https://github.com/daymade/claude-code-skills) +[![Version](https://img.shields.io/badge/version-1.22.0-green.svg)](https://github.com/daymade/claude-code-skills) [![Claude Code](https://img.shields.io/badge/Claude%20Code-2.0.13+-purple.svg)](https://claude.com/code) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/daymade/claude-code-skills/graphs/commit-activity) -专业的 Claude Code 技能市场,提供 28 个生产就绪的技能,用于增强开发工作流。 +专业的 Claude Code 技能市场,提供 30 个生产就绪的技能,用于增强开发工作流。 ## 📑 目录 @@ -219,6 +219,12 @@ claude plugin install twitter-reader@daymade-skills # macOS 磁盘空间清理 claude plugin install macos-cleaner@daymade-skills + +# 技能质量审查与改进 +claude plugin install skill-reviewer@daymade-skills + +# GitHub 贡献策略 +claude plugin install github-contributor@daymade-skills ``` 每个技能都可以独立安装 - 只选择你需要的! @@ -1189,6 +1195,108 @@ claude plugin install macos-cleaner@daymade-skills --- +### 27. **skill-reviewer** - 技能质量审查与改进 + +以三种强大模式审查和改进 Claude Code 技能,确保符合官方最佳实践。 + +**使用场景:** +- 发布前验证你自己的技能 +- 评估他人的技能仓库 +- 通过 auto-PR 为开源技能贡献改进 +- 确保技能符合市场标准 + +**主要功能:** +- **自检模式**:通过 skill-creator 脚本运行自动化验证 +- **外部审查模式**:克隆、分析并生成改进报告 +- **Auto-PR 模式**:Fork → 改进 → 提交 PR(仅添加性更改) +- **评估清单**:验证 frontmatter、说明、资源 +- **仅添加原则**:贡献他人项目时绝不删除文件 +- **PR 指南**:语气建议和专业模板 +- **自动安装依赖**:若缺少 skill-creator 则自动安装 + +**示例用法:** +```bash +# 安装技能 +claude plugin install skill-reviewer@daymade-skills + +# 自检你的技能 +"验证 ~/my-skills/my-awesome-skill 的技能" + +# 审查外部技能仓库 +"审查 https://github.com/user/skill-repo 的技能" + +# Auto-PR 改进 +"Fork、改进并为 https://github.com/user/skill-repo 提交 PR" +``` + +**🎬 实时演示** + +*即将推出* + +📚 **文档**:参见 [skill-reviewer/references/](./skill-reviewer/references/) 了解: +- `evaluation_checklist.md` - 完整的技能评估标准 +- `pr_template.md` - 专业 PR 描述模板 +- `marketplace_template.json` - marketplace 配置模板 + +--- + +### 28. **github-contributor** - GitHub 贡献策略 + +成为高效 GitHub 贡献者并建立开源声誉的战略指南。 + +**使用场景:** +- 寻找可贡献的项目 +- 学习贡献最佳实践 +- 建立你的 GitHub 影响力和声誉 +- 了解如何撰写高质量 PR + +**主要功能:** +- **四种贡献类型**:文档、代码质量、Bug 修复、功能开发 +- **项目选择标准**:优质首选项目 vs 危险信号 +- **PR 卓越工作流**:提交前 → 撰写中 → 提交后清单 +- **声誉建设阶梯**:文档 → Bug 修复 → 功能开发 → 维护者 +- **GitHub CLI 命令**:fork、PR、issue 操作快速参考 +- **约定式提交格式**:type、scope、description 结构 +- **常见错误**:需要避免的问题和最佳实践 + +**贡献类型解释:** +``` +Level 1: 文档修复(门槛最低,影响力高) + ↓ (建立熟悉度) +Level 2: 代码质量(中等努力,展示技能) + ↓ (理解代码库) +Level 3: Bug 修复(高影响力,建立信任) + ↓ (受信任的贡献者) +Level 4: 功能添加(最高可见度) + ↓ (潜在维护者) +``` + +**示例用法:** +```bash +# 安装技能 +claude plugin install github-contributor@daymade-skills + +# 找到好的首次贡献机会 +"帮我找一些 Python 项目中有 good first issue 的项目" + +# 撰写高质量 PR +"指导我为这个 bug 修复创建一个 PR" + +# 制定贡献策略 +"帮我规划一个建立 GitHub 档案的贡献策略" +``` + +**🎬 实时演示** + +*即将推出* + +📚 **文档**:参见 [github-contributor/references/](./github-contributor/references/) 了解: +- `pr_checklist.md` - 完整的 PR 质量清单 +- `project_evaluation.md` - 如何评估可贡献的项目 +- `communication_templates.md` - Issue 和 PR 沟通模板 + +--- + ## 🎬 交互式演示画廊 想要在一个地方查看所有演示并具有点击放大功能?访问我们的[交互式演示画廊](./demos/index.html)或浏览[演示目录](./demos/)。 @@ -1255,6 +1363,9 @@ claude plugin install macos-cleaner@daymade-skills ### 技能发现与管理 使用 **skills-search** 从 CCPM 注册表中查找、安装和管理 Claude Code 技能。非常适合为特定任务发现新技能、为常见工作流安装技能包,以及保持技能集合的有序管理。 +### 技能质量与开源贡献 +使用 **skill-reviewer** 在发布前验证你的技能是否符合最佳实践,或审查并改进他人的技能仓库。与 **github-contributor** 结合使用,寻找高影响力的开源项目、创建专业的 PR,并系统性地建立贡献者声誉。非常适合希望为 Claude Code 生态系统或任何 GitHub 项目做出贡献的开发者。 + ## 📚 文档 每个技能包括: @@ -1292,6 +1403,8 @@ claude plugin install macos-cleaner@daymade-skills - **iOS-APP-developer**:参见 `iOS-APP-developer/references/xcodegen-full.md` 了解 XcodeGen 选项与 project.yml 细节 - **twitter-reader**:参见 `twitter-reader/SKILL.md` 了解 API 密钥设置和 URL 格式支持 - **macos-cleaner**:参见 `macos-cleaner/references/cleanup_targets.md` 了解详细清理目标说明、`macos-cleaner/references/mole_integration.md` 了解 Mole 可视化工具集成、`macos-cleaner/references/safety_rules.md` 了解全面安全指南 +- **skill-reviewer**:参见 `skill-reviewer/references/evaluation_checklist.md` 了解完整评估标准、`skill-reviewer/references/pr_template.md` 了解 PR 模板、`skill-reviewer/references/marketplace_template.json` 了解 marketplace 配置 +- **github-contributor**:参见 `github-contributor/references/pr_checklist.md` 了解 PR 质量清单、`github-contributor/references/project_evaluation.md` 了解项目评估标准、`github-contributor/references/communication_templates.md` 了解 issue/PR 沟通模板 ## 🛠️ 系统要求 @@ -1393,4 +1506,4 @@ claude plugin install skill-name@daymade-skills **使用 skill-creator 技能为 Claude Code 精心打造 ❤️** -最后更新:2025-12-20 | 市场版本 1.18.0 +最后更新:2026-01-15 | 市场版本 1.22.0 diff --git a/github-contributor/.security-scan-passed b/github-contributor/.security-scan-passed new file mode 100644 index 0000000..a25f783 --- /dev/null +++ b/github-contributor/.security-scan-passed @@ -0,0 +1,4 @@ +Security scan passed +Scanned at: 2026-01-15T23:00:17.980955 +Tool: gitleaks + pattern-based validation +Content hash: 29b45018317a2ccdcf345364026e3a309a9a997ab493efb587944af6ec1de020 diff --git a/github-contributor/SKILL.md b/github-contributor/SKILL.md new file mode 100644 index 0000000..c3e02e8 --- /dev/null +++ b/github-contributor/SKILL.md @@ -0,0 +1,260 @@ +--- +name: github-contributor +description: Strategic guide for becoming an effective GitHub contributor. Covers opportunity discovery, project selection, high-quality PR creation, and reputation building. Use when looking to contribute to open-source projects, building GitHub presence, or learning contribution best practices. +--- + +# GitHub Contributor + +Strategic guide for becoming an effective GitHub contributor and building your open-source reputation. + +## The Strategy + +**Core insight**: Many open-source projects have room for improvement. By contributing high-quality PRs, you: +- Build contributor reputation +- Learn from top codebases +- Expand professional network +- Create public proof of skills + +## Contribution Types + +### 1. Documentation Improvements + +**Lowest barrier, high impact.** + +- Fix typos, grammar, unclear explanations +- Add missing examples +- Improve README structure +- Translate documentation + +``` +Opportunity signals: +- "docs", "documentation" labels +- Issues asking "how do I..." +- Outdated screenshots or examples +``` + +### 2. Code Quality Enhancements + +**Medium effort, demonstrates technical skill.** + +- Fix linter warnings +- Add type annotations +- Improve error messages +- Refactor for readability + +``` +Opportunity signals: +- "good first issue" label +- "tech debt" or "refactor" labels +- Code without tests +``` + +### 3. Bug Fixes + +**High impact, builds trust.** + +- Reproduce and fix reported bugs +- Add regression tests +- Document root cause + +``` +Opportunity signals: +- "bug" label with reproduction steps +- Issues with many thumbs up +- Stale bugs (maintainers busy) +``` + +### 4. Feature Additions + +**Highest effort, highest visibility.** + +- Implement requested features +- Add integrations +- Performance improvements + +``` +Opportunity signals: +- "help wanted" label +- Features with clear specs +- Issues linked to roadmap +``` + +## Project Selection + +### Good First Projects + +| Criteria | Why | +|----------|-----| +| Active maintainers | PRs get reviewed | +| Clear contribution guide | Know expectations | +| "good first issue" labels | Curated entry points | +| Recent merged PRs | Project is alive | +| Friendly community | Supportive feedback | + +### Red Flags + +- No activity in 6+ months +- Many open PRs without review +- Hostile issue discussions +- No contribution guidelines + +### Finding Projects + +```bash +# GitHub search for good first issues +gh search issues "good first issue" --language=python --sort=created + +# Search by topic +gh search repos "topic:cli" --sort=stars --limit=20 + +# Find repos you use +# Check dependencies in your projects +``` + +## PR Excellence + +### Before Writing Code + +``` +Pre-PR Checklist: +- [ ] Read CONTRIBUTING.md +- [ ] Check existing PRs for similar changes +- [ ] Comment on issue to claim it +- [ ] Understand project conventions +- [ ] Set up development environment +``` + +### Writing the PR + +**Title**: Clear, conventional format + +``` +feat: Add support for YAML config files +fix: Resolve race condition in connection pool +docs: Update installation instructions for Windows +refactor: Extract validation logic into separate module +``` + +**Description**: Structured and thorough + +```markdown +## Summary +[What this PR does in 1-2 sentences] + +## Motivation +[Why this change is needed] + +## Changes +- [Change 1] +- [Change 2] + +## Testing +[How you tested this] + +## Screenshots (if UI) +[Before/After images] +``` + +### After Submitting + +- Respond to feedback promptly +- Make requested changes quickly +- Be grateful for reviews +- Don't argue, discuss + +## Building Reputation + +### The Contribution Ladder + +``` +Level 1: Documentation fixes + ↓ (build familiarity) +Level 2: Small bug fixes + ↓ (understand codebase) +Level 3: Feature contributions + ↓ (trusted contributor) +Level 4: Maintainer status +``` + +### Consistency Over Volume + +``` +❌ 10 PRs in one week, then nothing +✅ 1-2 PRs per week, sustained +``` + +### Engage Beyond PRs + +- Answer questions in issues +- Help triage bug reports +- Review others' PRs (if welcome) +- Join project Discord/Slack + +## Common Mistakes + +### Don't + +- Submit drive-by PRs without context +- Argue with maintainers +- Ignore code style guidelines +- Make massive changes without discussion +- Ghost after submitting + +### Do + +- Start with small, focused PRs +- Follow project conventions exactly +- Communicate proactively +- Accept feedback gracefully +- Build relationships over time + +## Workflow Template + +``` +Contribution Workflow: +- [ ] Find project with "good first issue" +- [ ] Read contribution guidelines +- [ ] Comment on issue to claim +- [ ] Fork and set up locally +- [ ] Make focused changes +- [ ] Test thoroughly +- [ ] Write clear PR description +- [ ] Respond to review feedback +- [ ] Celebrate when merged! 🎉 +``` + +## Quick Reference + +### GitHub CLI Commands + +```bash +# Fork a repo +gh repo fork owner/repo --clone + +# Create PR +gh pr create --title "feat: ..." --body "..." + +# Check PR status +gh pr status + +# View project issues +gh issue list --repo owner/repo --label "good first issue" +``` + +### Commit Message Format + +``` +(): + +[optional body] + +[optional footer] +``` + +Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore` + +## References + +- `references/pr_checklist.md` - Complete PR quality checklist +- `references/project_evaluation.md` - How to evaluate projects +- `references/communication_templates.md` - Issue/PR templates diff --git a/github-contributor/references/communication_templates.md b/github-contributor/references/communication_templates.md new file mode 100644 index 0000000..f898377 --- /dev/null +++ b/github-contributor/references/communication_templates.md @@ -0,0 +1,228 @@ +# Communication Templates + +Templates for effective open-source communication. + +## Claiming an Issue + +### First-Time Contributor + +```markdown +Hi! I'm interested in working on this issue. + +I'm new to the project but I've read the contributing guidelines and set up the development environment. I think I understand the scope of the change needed. + +My approach would be to: +1. [Step 1] +2. [Step 2] +3. [Step 3] + +Does this sound reasonable? Any guidance would be appreciated! +``` + +### Experienced Contributor + +```markdown +I'd like to take this on. + +Proposed approach: +- [Technical approach] +- [Testing strategy] + +ETA: [timeframe] + +Let me know if there are any concerns or if someone else is already working on this. +``` + +## Asking for Clarification + +```markdown +Thanks for filing this issue! + +I'd like to work on this but need some clarification: + +1. [Question 1] +2. [Question 2] + +Once I understand these points, I can start on a fix. +``` + +## PR Description + +### Bug Fix + +```markdown +## Summary + +Fixes #[issue number] + +This PR resolves the [bug description] by [solution approach]. + +## Root Cause + +The issue was caused by [explanation]. + +## Solution + +[Detailed explanation of the fix] + +## Testing + +- [x] Added regression test +- [x] Verified fix locally +- [x] All existing tests pass + +## Screenshots (if applicable) + +Before: +[image] + +After: +[image] +``` + +### Feature Addition + +```markdown +## Summary + +Implements #[issue number] + +Adds [feature description] to enable [use case]. + +## Changes + +- Added `feature.py` with [functionality] +- Updated `config.py` to support [new option] +- Added tests in `test_feature.py` + +## Usage + +```python +# Example usage +from project import new_feature +result = new_feature(...) +``` + +## Testing + +- [x] Unit tests added +- [x] Integration tests pass +- [x] Documentation updated + +## Migration Guide (if breaking) + +[Instructions for users to migrate] +``` + +### Documentation Update + +```markdown +## Summary + +Improves documentation for [area]. + +## Changes + +- Fixed typos in [file] +- Added examples for [feature] +- Updated outdated [section] +- Clarified [confusing part] + +## Preview + +[Screenshot or link to rendered docs] +``` + +## Responding to Reviews + +### Accepting Feedback + +```markdown +Good catch! I've updated the code to [change]. + +See commit [hash]. +``` + +### Explaining a Decision + +```markdown +Thanks for the review! + +I chose this approach because: +1. [Reason 1] +2. [Reason 2] + +However, I'm open to changing it if you think [alternative] would be better. What do you think? +``` + +### Requesting Clarification + +```markdown +Thanks for the feedback! + +Could you clarify what you mean by [quote]? I want to make sure I address your concern correctly. +``` + +### Disagreeing Respectfully + +```markdown +I see your point about [concern]. + +I went with the current approach because [reasoning]. However, I understand the tradeoff you're highlighting. + +Would a middle ground like [alternative] address your concern while keeping [benefit]? +``` + +## After Merge + +```markdown +Thanks for the review and merge! 🎉 + +I learned [something] from the feedback - I'll apply that in future contributions. + +Looking forward to contributing more to the project! +``` + +## Abandoning a PR + +```markdown +Hi, I won't be able to complete this PR due to [reason]. + +I've pushed my current progress in case someone else wants to continue from here. The remaining work is: +- [ ] [Task 1] +- [ ] [Task 2] + +Sorry for any inconvenience, and thanks for the opportunity to contribute! +``` + +## Tone Guidelines + +### Always + +- Be grateful +- Be specific +- Be patient +- Be humble + +### Never + +- Be defensive +- Be dismissive +- Be demanding +- Be passive-aggressive + +### Word Choice + +``` +❌ "You should..." +✅ "It might help to..." + +❌ "This is wrong" +✅ "I think there might be an issue with..." + +❌ "Obviously..." +✅ "One approach could be..." + +❌ "Why didn't you..." +✅ "Could you help me understand..." +``` diff --git a/github-contributor/references/pr_checklist.md b/github-contributor/references/pr_checklist.md new file mode 100644 index 0000000..625c1c5 --- /dev/null +++ b/github-contributor/references/pr_checklist.md @@ -0,0 +1,155 @@ +# PR Quality Checklist + +Complete checklist for creating high-quality pull requests. + +## Before Starting + +- [ ] Read CONTRIBUTING.md thoroughly +- [ ] Check for existing PRs addressing same issue +- [ ] Comment on issue to express interest +- [ ] Wait for maintainer acknowledgment (if required) +- [ ] Understand project's code style + +## Environment Setup + +- [ ] Fork repository +- [ ] Clone to local machine +- [ ] Set up development environment +- [ ] Run existing tests (ensure they pass) +- [ ] Create feature branch with descriptive name + +```bash +# Branch naming conventions +feature/add-yaml-support +fix/resolve-connection-timeout +docs/update-installation-guide +refactor/extract-validation-logic +``` + +## During Development + +- [ ] Make small, focused commits +- [ ] Follow project's commit message format +- [ ] Add tests for new functionality +- [ ] Update documentation if needed +- [ ] Run linter/formatter before committing + +## Before Submitting + +### Code Quality + +- [ ] All tests pass +- [ ] No linter warnings +- [ ] Code follows project style +- [ ] No unnecessary changes (whitespace, imports) +- [ ] Comments explain "why", not "what" + +### Documentation + +- [ ] README updated (if applicable) +- [ ] API docs updated (if applicable) +- [ ] Inline comments added for complex logic +- [ ] CHANGELOG updated (if required) + +### PR Description + +- [ ] Clear, descriptive title +- [ ] Summary of changes +- [ ] Motivation/context +- [ ] Testing approach +- [ ] Screenshots (for UI changes) +- [ ] Related issues linked + +## PR Title Format + +``` +(): + +Examples: +feat(api): add support for batch requests +fix(auth): resolve token refresh race condition +docs(readme): add troubleshooting section +refactor(utils): simplify date parsing logic +test(api): add integration tests for search endpoint +chore(deps): update lodash to 4.17.21 +``` + +## PR Description Template + +```markdown +## Summary + +Brief description of what this PR does. + +## Motivation + +Why is this change needed? Link to issue if applicable. + +Closes #123 + +## Changes + +- Change 1 +- Change 2 +- Change 3 + +## Testing + +How did you test this change? + +- [ ] Unit tests added/updated +- [ ] Manual testing performed +- [ ] Integration tests pass + +## Screenshots (if applicable) + +| Before | After | +|--------|-------| +| image | image | + +## Checklist + +- [ ] Tests pass +- [ ] Documentation updated +- [ ] Code follows project style +``` + +## After Submitting + +- [ ] Monitor for CI results +- [ ] Respond to review comments promptly +- [ ] Make requested changes quickly +- [ ] Thank reviewers for their time +- [ ] Don't force push after review starts (unless asked) + +## Review Response Etiquette + +### Good Responses + +``` +"Good point! I've updated the implementation to..." + +"Thanks for catching that. Fixed in commit abc123." + +"I see what you mean. I chose this approach because... +Would you prefer if I changed it to...?" +``` + +### Avoid + +``` +"That's just your opinion." + +"It works on my machine." + +"This is how I always do it." +``` + +## Common Rejection Reasons + +1. **Too large** - Break into smaller PRs +2. **Unrelated changes** - Remove scope creep +3. **Missing tests** - Add test coverage +4. **Style violations** - Run formatter +5. **No issue link** - Create or link issue first +6. **Conflicts** - Rebase on latest main diff --git a/github-contributor/references/project_evaluation.md b/github-contributor/references/project_evaluation.md new file mode 100644 index 0000000..8916de7 --- /dev/null +++ b/github-contributor/references/project_evaluation.md @@ -0,0 +1,149 @@ +# Project Evaluation Guide + +How to evaluate open-source projects before contributing. + +## Quick Health Check + +```bash +# Check recent activity +gh repo view owner/repo --json updatedAt,stargazersCount,openIssues + +# Check PR response time +gh pr list --repo owner/repo --state merged --limit 10 + +# Check issue activity +gh issue list --repo owner/repo --limit 20 +``` + +## Evaluation Criteria + +### 1. Activity Level + +| Signal | Good | Bad | +|--------|------|-----| +| Last commit | < 1 month | > 6 months | +| Open PRs | Being reviewed | Ignored | +| Issue responses | Within days | Never | +| Release frequency | Regular | Years ago | + +### 2. Community Health + +| Signal | Good | Bad | +|--------|------|-----| +| CONTRIBUTING.md | Exists, detailed | Missing | +| Code of Conduct | Present | Missing | +| Issue templates | Well-structured | None | +| Discussion tone | Friendly, helpful | Hostile | + +### 3. Maintainer Engagement + +| Signal | Good | Bad | +|--------|------|-----| +| Review comments | Constructive | Dismissive | +| Response time | Days | Months | +| Merge rate | Regular merges | Stale PRs | +| New contributor PRs | Welcomed | Ignored | + +### 4. Documentation Quality + +| Signal | Good | Bad | +|--------|------|-----| +| README | Clear, comprehensive | Minimal | +| Getting started | Easy to follow | Missing | +| API docs | Complete | Outdated | +| Examples | Working, relevant | Broken | + +## Scoring System + +Rate each category 1-5: + +``` +Activity Level: _/5 +Community Health: _/5 +Maintainer Engage: _/5 +Documentation: _/5 +---------------------------- +Total: _/20 +``` + +**Interpretation:** +- 16-20: Excellent choice +- 12-15: Good, proceed with caution +- 8-11: Consider carefully +- < 8: Avoid or expect delays + +## Red Flags + +### Immediate Disqualifiers + +- No commits in 1+ year +- Maintainer explicitly stepped away +- Project archived +- License issues + +### Warning Signs + +- Many open PRs without review +- Hostile responses to contributors +- No clear contribution path +- Overly complex setup + +## Green Flags + +### Strong Indicators + +- "good first issue" labels maintained +- Active Discord/Slack community +- Regular release schedule +- Responsive maintainers +- Clear roadmap + +### Bonus Points + +- Funded/sponsored project +- Multiple active maintainers +- Good test coverage +- CI/CD pipeline + +## Research Checklist + +``` +Project Evaluation: +- [ ] Check GitHub Insights +- [ ] Read recent issues +- [ ] Review merged PRs +- [ ] Check contributor guide +- [ ] Look for "good first issue" +- [ ] Assess community tone +- [ ] Verify active maintenance +- [ ] Confirm compatible license +``` + +## Finding Projects + +### By Interest + +```bash +# Find by topic +gh search repos "topic:cli" --sort=stars + +# Find by language +gh search repos "language:python" --sort=stars + +# Find with good first issues +gh search issues "good first issue" --language=rust +``` + +### By Need + +- Tools you use daily +- Libraries in your projects +- Frameworks you're learning +- Problems you've encountered + +### Curated Lists + +- awesome-for-beginners +- first-timers-only +- up-for-grabs.net +- goodfirstissue.dev diff --git a/skill-reviewer/.security-scan-passed b/skill-reviewer/.security-scan-passed new file mode 100644 index 0000000..8a9b60a --- /dev/null +++ b/skill-reviewer/.security-scan-passed @@ -0,0 +1,4 @@ +Security scan passed +Scanned at: 2026-01-15T23:00:17.123502 +Tool: gitleaks + pattern-based validation +Content hash: 0c696633f662b65e56b69a2c88a8fadd5fa5a501d1832a47d81201fc4a1fa097 diff --git a/skill-reviewer/SKILL.md b/skill-reviewer/SKILL.md new file mode 100644 index 0000000..9dda4f6 --- /dev/null +++ b/skill-reviewer/SKILL.md @@ -0,0 +1,200 @@ +--- +name: skill-reviewer +description: Reviews and improves Claude Code skills against official best practices. Supports three modes - self-review (validate your own skills), external review (evaluate others' skills), and auto-PR (fork, improve, submit). Use when checking skill quality, reviewing skill repositories, or contributing improvements to open-source skills. +--- + +# Skill Reviewer + +Review and improve Claude Code skills against official best practices. + +## Setup (Auto-Install Dependencies) + +Before using this skill, ensure `skill-creator` is installed for automated validation. + +**Auto-install sequence:** + +```bash +# 1. Check if skill-creator exists +SKILL_CREATOR=$(find ~/.claude/plugins/cache -name "skill-creator" -type d 2>/dev/null | head -1) + +# 2. If not found, install it +if [ -z "$SKILL_CREATOR" ]; then + claude plugin marketplace add https://github.com/daymade/claude-code-skills + claude plugin install skill-creator@daymade-skills + SKILL_CREATOR=$(find ~/.claude/plugins/cache -name "skill-creator" -type d 2>/dev/null | head -1) +fi + +echo "skill-creator location: $SKILL_CREATOR" +``` + +## Three Modes + +### Mode 1: Self-Review + +Check your own skill before publishing. + +**Automated validation** (run after setup): + +```bash +# Quick validation +python3 "$SKILL_CREATOR"/*/quick_validate.py + +# Security scan +python3 "$SKILL_CREATOR"/*/security_scan.py --verbose +``` + +**Manual evaluation**: See `references/evaluation_checklist.md`. + +### Mode 2: External Review + +Evaluate someone else's skill repository. + +``` +Review Workflow: +- [ ] Clone repository to /tmp/ +- [ ] Read ALL documentation first +- [ ] Identify author's intent +- [ ] Run evaluation checklist +- [ ] Generate improvement report +``` + +### Mode 3: Auto-PR + +Fork, improve, and submit PR to external skill repository. + +``` +Auto-PR Workflow: +- [ ] Fork repository (gh repo fork) +- [ ] Create feature branch +- [ ] Apply additive improvements only +- [ ] Self-review: respect check passed? +- [ ] Create PR with detailed explanation +``` + +## Evaluation Checklist (Quick) + +| Category | Check | Status | +|----------|-------|--------| +| **Frontmatter** | name present? | | +| | description present? | | +| | description in third-person? | | +| | includes trigger conditions? | | +| **Instructions** | imperative form? | | +| | under 500 lines? | | +| | workflow pattern? | | +| **Resources** | no hardcoded paths? | | +| | scripts have error handling? | | + +Full checklist: `references/evaluation_checklist.md` + +## Core Principle: Additive Only + +When improving external skills, NEVER: +- Delete existing files +- Remove functionality +- Change primary language +- Rename components + +ALWAYS: +- Add new capabilities +- Preserve original content +- Explain every change + +``` +❌ "Removed metadata.json (non-standard)" +✅ "Added marketplace.json (metadata.json preserved)" + +❌ "Rewrote README in English" +✅ "Added README.en.md (Chinese preserved as default)" +``` + +## Common Issues & Fixes + +### Issue: Description Not Third-Person + +```yaml +# Before +description: Browse YouTube videos and summarize them. + +# After +description: Browses YouTube videos and generates summaries. Use when... +``` + +### Issue: Missing Trigger Conditions + +```yaml +# Before +description: Processes PDF files. + +# After +description: Extracts text from PDFs. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction. +``` + +### Issue: No Workflow Pattern + +Add checklist for complex tasks: + +```markdown +## Workflow + +Copy this checklist: + +\`\`\` +Task Progress: +- [ ] Step 1: ... +- [ ] Step 2: ... +\`\`\` +``` + +### Issue: Missing Marketplace Support + +```bash +mkdir -p .claude-plugin +# Create marketplace.json from template +``` + +See `references/marketplace_template.json`. + +## PR Guidelines + +When submitting PRs to external repos: + +### Tone + +``` +❌ "Your skill doesn't follow best practices" +✅ "This PR aligns with best practices for better discoverability" + +❌ "Fixed the incorrect description" +✅ "Improved description with trigger conditions" +``` + +### Required Sections + +1. **Summary** - What this PR does +2. **What's NOT Changed** - Show respect for original +3. **Rationale** - Why each change helps +4. **Test Plan** - How to verify + +Template: `references/pr_template.md` + +## Self-Review Checklist + +Before submitting any PR: + +``` +Respect Check: +- [ ] No files deleted? +- [ ] No functionality removed? +- [ ] Original language preserved? +- [ ] Author's design decisions respected? +- [ ] All changes are additive? +- [ ] PR explains the "why"? +``` + +## References + +- `references/evaluation_checklist.md` - Full evaluation checklist +- `references/pr_template.md` - PR description template +- `references/marketplace_template.json` - marketplace.json template +- Best practices: https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices diff --git a/skill-reviewer/references/evaluation_checklist.md b/skill-reviewer/references/evaluation_checklist.md new file mode 100644 index 0000000..1f866b9 --- /dev/null +++ b/skill-reviewer/references/evaluation_checklist.md @@ -0,0 +1,111 @@ +# Skill Evaluation Checklist + +Complete checklist for evaluating Claude Code skills against best practices. + +## YAML Frontmatter + +- [ ] `name` field present and valid + - Max 64 characters + - Lowercase letters, numbers, hyphens only + - No reserved words (anthropic, claude) +- [ ] `description` field present and valid + - Non-empty + - Max 1024 characters + - Third-person voice + - Includes trigger conditions ("Use when...") + +## Description Quality + +### Third-Person Voice Check + +``` +❌ "Browse YouTube videos..." +❌ "You can use this to..." +❌ "I can help you..." +✅ "Browses YouTube videos..." +✅ "This skill processes..." +``` + +### Trigger Conditions Check + +Description should include: +- What the skill does +- When to use it +- Specific triggers (file types, keywords, scenarios) + +``` +❌ "Processes PDFs" +✅ "Extracts text and tables from PDF files. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction." +``` + +## Instruction Quality + +- [ ] Imperative/infinitive form used (verb-first) +- [ ] Concise (avoid obvious explanations) +- [ ] Clear workflow steps +- [ ] Checklist pattern for complex tasks + +### Imperative Form Check + +``` +❌ "You should run the script..." +❌ "The user can configure..." +✅ "Run the script..." +✅ "Configure by editing..." +``` + +## Progressive Disclosure + +- [ ] SKILL.md body under 500 lines +- [ ] Detailed content in `references/` +- [ ] Large files include grep patterns +- [ ] No duplication between SKILL.md and references + +## Bundled Resources + +### Scripts (`scripts/`) +- [ ] Executable with proper shebang +- [ ] Explicit error handling (no bare except) +- [ ] Clear documentation +- [ ] No hardcoded secrets + +### References (`references/`) +- [ ] Self-explanatory filenames +- [ ] Loaded as needed, not always +- [ ] No duplication with SKILL.md + +### Assets (`assets/`) +- [ ] Used in output, not loaded into context +- [ ] Templates, images, boilerplate + +## Privacy and Paths + +- [ ] No absolute user paths (`/Users/username/`) +- [ ] No personal/company names +- [ ] No hardcoded secrets +- [ ] Relative paths only + +## Workflow Pattern + +- [ ] Clear sequential steps +- [ ] Copy-paste checklist provided +- [ ] Validation/verification steps included + +## Error Handling + +- [ ] Scripts have specific exception types +- [ ] Error messages are helpful +- [ ] Recovery paths documented + +## Summary Table + +| Category | Status | Notes | +|----------|--------|-------| +| Frontmatter | | | +| Description | | | +| Instructions | | | +| Progressive Disclosure | | | +| Resources | | | +| Privacy | | | +| Workflow | | | +| Error Handling | | | diff --git a/skill-reviewer/references/marketplace_template.json b/skill-reviewer/references/marketplace_template.json new file mode 100644 index 0000000..8a37b7e --- /dev/null +++ b/skill-reviewer/references/marketplace_template.json @@ -0,0 +1,27 @@ +{ + "metadata": { + "name": "{marketplace-name}", + "description": "{Brief description of the marketplace/skill collection}", + "owner": "{github-username}", + "version": "1.0.0", + "homepage": "https://github.com/{owner}/{repo}" + }, + "plugins": [ + { + "name": "{skill-name}", + "description": "{Copy from SKILL.md frontmatter description - must be third-person and include trigger conditions}", + "source": "./", + "strict": false, + "version": "1.0.0", + "category": "{category}", + "keywords": [ + "{keyword1}", + "{keyword2}", + "{keyword3}" + ], + "skills": [ + "./" + ] + } + ] +} diff --git a/skill-reviewer/references/pr_template.md b/skill-reviewer/references/pr_template.md new file mode 100644 index 0000000..5d1bff7 --- /dev/null +++ b/skill-reviewer/references/pr_template.md @@ -0,0 +1,129 @@ +# PR Template for Skill Contributions + +Use this template when creating PRs for Claude Code skill repositories. + +## PR Title Format + +``` +refactor: Align skill with Claude Code best practices +``` + +Or for specific improvements: +``` +feat: Add marketplace support for plugin installation +docs: Add bilingual documentation (English/Chinese) +fix: Improve error handling in scripts +``` + +## PR Body Template + +```markdown +## Summary + +This PR improves the [skill-name] skill by aligning it with [Claude Code Skill Best Practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices). + +### What This PR Does + +- [Improvement 1] +- [Improvement 2] +- [Improvement 3] + +### What This PR Does NOT Change + +- [Preserved item 1] +- [Preserved item 2] + +## Detailed Changes + +### 1. [Change Category] + +**Before:** +[Description of current state] + +**After:** +[Description of improvement] + +**Rationale:** +[Why this change helps users] + +### 2. [Change Category] + +... + +## Why These Changes? + +According to Claude Code best practices: + +> "[Quote from documentation]" + +This PR addresses: +- [Issue 1 and how it's fixed] +- [Issue 2 and how it's fixed] + +## Files Changed + +| File | Change Type | Description | +|------|-------------|-------------| +| SKILL.md | Modified | Improved description and workflow | +| README.md | Modified | Added installation instructions | +| README.en.md | Added | English documentation | +| .claude-plugin/marketplace.json | Added | Plugin marketplace support | + +## Test Plan + +- [ ] Test 1 +- [ ] Test 2 +- [ ] Test 3 + +## References + +- [Claude Code Skill Best Practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) +- [Skills Overview](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) + +--- + +🤖 Generated with [Claude Code](https://claude.com/claude-code) +``` + +## Key Sections Explained + +### Summary +- Brief overview (2-3 sentences) +- Link to best practices + +### What This PR Does NOT Change +**CRITICAL** - Always include this section to show respect for original work. + +### Rationale +- Explain WHY each change helps +- Quote official documentation +- Don't be judgmental + +### Test Plan +- Provide actionable verification steps +- Help maintainers review quickly + +## Tone Guidelines + +### Do +- Be helpful and constructive +- Explain benefits to users +- Acknowledge good aspects of original + +### Don't +- Be critical or judgmental +- Imply the original is "wrong" +- Use words like "fix", "correct", "proper" negatively + +### Examples + +``` +❌ "Fixed the incorrect description format" +✅ "Improved description for better skill discovery" + +❌ "The skill had several issues..." +✅ "This PR adds improvements for..." + +❌ "Corrected the non-standard structure" +✅ "Added marketplace support for easier installation" +```