mcpField
G
github-repo

github-repo

github.com/jdevalk开发10974 次安装19 周前更新
代码仓库

关于 github-repo

github-repo 是用于审查 GitHub 仓库并创建或改进维护类文件的技能，面向仓库维护者。它可处理在线仓库、本地 Git 目录或用户提供的文件，并依据 AGENTS.md 中的方案生成内容。

主要功能

  1. 01审查六类仓库质量
  2. 02支持在线及本地仓库
  3. 03生成或改进仓库文件
  4. 04检查元数据与文本可读性
  5. 05验证文件位置及链接

适用场景

  1. 01检查仓库对外呈现质量
  2. 02补充缺失的社区维护文件
  3. 03改进 README 和议题模板
  4. 04检查仓库元数据与文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/jdevalk/skills --skill github-repo

安装后在 Claude Code 中输入/github-repo确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

AGENTS.md
README.md
evals/
evals.json

详细介绍

GitHub 仓库优化器

此技能会根据最佳实践审查 GitHub 仓库，并生成或改进相关文件，让仓库显得专业、友好且维护良好。它支持通过 gh CLI 操作在线仓库、本地 git 目录，或用户提供的文件。

具体文件的生成与改进方案见 AGENTS.md——需要生成或改进特定文件时，请阅读该文件。本文介绍工作流和审查清单。

工作流

  1. 收集仓库背景信息 — 确定当前处理对象并收集信息
  2. 执行审查 — 评估仓库面向公众的各项质量
  3. 生成或改进文件 — 补齐缺失或需要改进的文件。具体方案见 AGENTS.md。
  4. 元数据与可读性检查 — 对仓库描述和 README 简介运行 metadata-check；对以文字为主的文件运行 readability-check。
  5. 验证 — 确认输出正确且完整

阶段 0：收集背景信息

需要收集的关键信息：仓库名称、描述、语言/框架、README 是否存在及其质量、已有的社区健康文件、问题/PR 模板状态、CI/CD 状态、发布历史、分支数量。如果已通过身份验证，则使用 gh CLI；否则读取本地文件。

阶段 1：审查

每个类别按 10 分制评分。每个类别给出 2–4 条具体发现，并引用实际情况。

README 质量（x/10）

README 是否存在？结构是否完善，是否包含：项目名称和清晰的一句话介绍、徽章行（构建/许可证/版本）、说明项目是什么、为什么需要、适用对象的描述、快速入门（安装和首次使用不超过 3 步）、代码示例（如涉及视觉内容，需提供截图/演示）、配置文档、贡献指南链接、许可证说明？是否少于 500 行，并用 <details> 收纳可选内容？

仓库元数据（x/10）
  • 描述是否已设置且有用（非空，也不是“My awesome project”）？
  • Topics/标签是否相关且完整？
  • 如适用，是否设置了网站 URL？
  • 是否上传了社交预览图？
  • 如果未使用，是否隐藏了“Packages”“Environments”“Deployments”版块？
社区健康文件（x/10）
  • CONTRIBUTING.md — 是否存在？是否涵盖开发环境设置、代码风格、测试和 PR 流程？
  • SECURITY.md — 是否存在？是否指明私密报告渠道，并说明响应时间？
  • CODE_OF_CONDUCT.md — 是否存在？Contributor Covenant 2.1 是标准。
  • LICENSE — 根目录中是否存在？是否适合项目类型？
  • SUPPORT.md — 是否存在？是否区分错误报告和支持问题？
  • CHANGELOG.md — 是否遵循 Keep a Changelog 格式？

对于组织：检查是否有 .github 仓库，用于存放组织范围的默认健康文件。

问题与 PR 模板（x/10）
  • 是否使用基于 YAML 的问题表单（.github/ISSUE_TEMPLATE/*.yml），且至少包含错误报告和功能请求？是否使用带编号的文件名来控制顺序？
  • config.yml 是否禁用了空白问题，并链接到外部支持渠道？
  • PR 模板是否包含描述、相关问题（Closes #XXX）、更改类型复选框和测试清单？
  • 是否有按目录定义审阅者的 CODEOWNERS 文件？
CI/CD 与自动化（x/10）
  • 是否有用于测试、代码检查和构建的 GitHub Actions 工作流？README 中的状态徽章是否显示通过？
  • 是否配置了 Dependabot 或 Renovate？
  • 是否配置了代码质量工具（CodeQL、代码检查操作）？
  • 是否管理过期问题？
发布与分支管理（x/10）
  • 是否有带变更日志的标签发布？是否采用语义化版本？
  • 是否清理了过期分支？
  • 是否有包含 export-ignore 的 .gitattributes？
  • 是否配置了自动发布（semantic-release 或 release-please）？

阶段 2：生成或改进文件

根据审计结果，生成缺失或需要改进的文件。覆盖文件前务必先询问。阅读 AGENTS.md，了解详细操作说明。

按影响程度排序的文件生成顺序：README.md、LICENSE、CONTRIBUTING.md、SECURITY.md、CODE_OF_CONDUCT.md、issue 模板、PR 模板、CHANGELOG.md、SUPPORT.md、配置文件（dependabot.yml、CODEOWNERS、FUNDING.yml）。

AGENTS.md 章节：README 生成、社区健康文件（CONTRIBUTING、SECURITY、CODE_OF_CONDUCT）、Issue 模板、组织级设置（.github 仓库、组织资料、私有成员资料、域名验证、规则集）。

阶段 2.5：元数据与可读性检查

  1. 元数据检查 — metadata-check 技能。 检查仓库描述（前约 100 个字符会显示在搜索结果和资料卡片中）以及 README 的开篇简介。
  2. 文本检查 — readability-check 技能。 检查所有以文本为主的文件，至少包括 README，以及你创建的 CONTRIBUTING.md 和 SECURITY.md。

直接应用修复。代码占比较高的文件（Issue 模板、工作流 YAML）可跳过。

阶段 3：验证

  • 确认文件位于正确位置。
  • 检查 README 中的所有内部链接是否有效。
  • 确认徽章 URL 格式正确。
  • 如果可以使用 gh，提醒用户更新仓库的 About 部分（描述、主题、网站 URL、社交预览）——这些内容无法仅通过文件设置。
  • 总结创建或更改的内容，以及用户接下来应采取的操作。

输出格式

评分表（6 个类别，总分 60），按组列出发现的问题并引用实际情况，列出生成或更改的文件，以及用户接下来的操作。

评论

支持 Markdown