mcpField
C
configure-readme

configure-readme

github.com/laurigates开发5962 次安装1 天前更新
代码仓库

关于 configure-readme

这是一项用于审查和配置项目 README 的技能，涵盖章节检查和生成标准化文档。适合希望统一 README 结构、设置命令及项目元数据的维护者。

主要功能

  1. 01检查 README 章节与规范
  2. 02检测项目元数据和命令
  3. 03生成标准化 README 内容
  4. 04配置徽章和项目结构
  5. 05验证链接与 Markdown 格式

适用场景

  1. 01发布前检查 README
  2. 02统一多个项目的 README
  3. 03生成安装与使用章节

安装

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

$npx skills add https://github.com/laurigates/claude-plugins --skill configure-readme

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

附带文件REFERENCE.md

详细介绍

适用场景

在以下情况下使用此技能……在以下情况下采用其他方法……
从头为新项目创建 README.md编辑 README 的特定内容——使用直接文件编辑
审查现有 README 是否缺少某些章节（徽章、安装、结构）编写详细的 API 文档——使用 /configure:docs
统一多个项目的 README 格式创建 GitHub Pages 文档站点——使用 /configure:github-pages
添加 shields.io 徽章、技术栈表格或项目结构章节编写变更日志——通过约定式提交使用 release-please 自动化
确保 README 包含适用于检测到的技术栈的正确安装／构建／测试命令只需更新单个章节——直接编辑文件

上下文

  • 项目根目录：!pwd
  • 项目名称：!basename $(pwd)
  • README 是否存在：!find . -maxdepth 1 -name 'README.md'
  • 包文件：!find . -maxdepth 1 \( -name 'package.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' -o -name 'go.mod' \)
  • Git 远程仓库：!git remote -v
  • 许可证文件：!find . -maxdepth 1 -name 'LICENSE*'
  • 资源目录：!find . -maxdepth 2 -type d \( -name 'assets' -o -name 'public' -o -name 'images' \)
  • Logo 文件：!find . -maxdepth 3 -type f \( -name 'logo*' -o -name 'icon*' \)

参数

从命令参数中解析：

  • --check-only：报告 README 合规状态，不进行修改（CI/CD 模式）
  • --fix：无需提示，自动应用修复
  • --style <minimal|standard|detailed>：README 详细程度（默认：standard）
  • --badges <shields|custom>：徽章样式偏好（默认：shields）
  • --no-logo：即使存在资源，也跳过 Logo 章节

样式级别：

  • minimal：标题、描述、徽章、基本安装／用法
  • standard：Logo、徽章、功能、技术栈、快速入门、许可证（推荐）
  • detailed：包含 standard 的全部内容，另加：架构图、API 参考、贡献指南、变更日志链接

执行

执行此 README 配置工作流：

步骤 1：检测项目元数据

从检测到的包文件中读取项目元数据：

  1. package.json（JavaScript/TypeScript）：提取 name、description、version、license、repository、keywords
  2. pyproject.toml（Python）：提取项目名称、描述、版本、许可证、关键词、URL
  3. Cargo.toml（Rust）：提取 package name、description、version、license、repository、keywords
  4. go.mod（Go）：提取用于确定所有者／仓库的模块路径

未匹配到包文件时的回退检测：

  • 项目名称：目录名称
  • 描述：现有 README 的第一行，或询问用户
  • 仓库：Git 远程 URL
  • 许可证：LICENSE 文件内容

有关包文件格式的详细示例，请参阅 REFERENCE.md。

步骤 2：分析当前 README 状态

检查现有 README.md 是否包含以下章节：

  • 存在 Logo／图标（顶部居中的图片）
  • 项目标题（h1）
  • 描述／标语
  • 徽章行（许可证、版本、CI 状态、覆盖率）
  • 功能章节
  • 技术栈章节
  • 先决条件章节
  • 安装说明
  • 用法示例
  • 项目结构
  • 贡献指南
  • 许可证章节

在常见位置查找 Logo／图标资源：

  • assets/logo.png、assets/icon.png、assets/logo.svg
  • public/logo.png、public/icon.svg
  • images/logo.png、docs/assets/logo.png
  • .github/logo.png、.github/images/logo.png
步骤 3：生成合规报告

按章节打印合规报告，显示 README 各章节的 PASS/MISSING/PARTIAL 状态。报告还应包含内容质量检查（代码示例、命令正确性、链接有效性）。

如果设置了 --check-only，则在此处停止。

有关合规报告格式，请参阅 REFERENCE.md。

步骤 4：应用配置（如果指定了 --fix 或用户确认）

按照标准模板结构生成 README.md：

  1. 居中的 Logo 区域（如果存在资源且未设置 --no-logo）
  2. 项目标题和标语
  3. 包含 shields.io URL 的徽章行
  4. 功能部分，介绍主要亮点
  5. 技术栈表格
  6. 入门指南（前提条件、安装、使用方法）
  7. 项目结构
  8. 开发命令
  9. 贡献部分
  10. 许可证部分

完整的 README 模板和徽章 URL 格式，请参阅 REFERENCE.md。

步骤 5：处理 Logo 和资源

如果不存在 Logo，但用户希望添加：

  1. 检查标准位置中是否存在现有资源
  2. 建议创建简单的文本占位图，或使用 Emoji 标题
  3. 如有需要，创建资源目录：mkdir -p assets
  4. 推荐工具：Shields.io 用于自定义徽章，Simple Icons 用于技术图标
步骤 6：检测项目命令

根据包管理器/构建工具自动检测项目命令：

包管理器安装运行测试构建
npm/bun (package.json)从 package.json 中读取 scriptsnpm run devnpm testnpm run build
uv/poetry (pyproject.toml)uv sync / poetry installuv run python -m pkguv run pytest-
cargo (Cargo.toml)cargo buildcargo runcargo testcargo build --release
go (go.mod)go buildgo run .go test ./...go build
步骤 7：生成项目结构

运行 tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst 以生成准确的项目结构。跳过常见的生成目录（node_modules、vendor、target、dist、build、pycache、.pytest_cache、.git、.venv、venv）。

步骤 8：更新规范跟踪

更新 .project-standards.yaml：

components:
  readme: "2025.1"
  readme_style: "[minimal|standard|detailed]"
  readme_has_logo: true|false
  readme_badges: ["license", "stars", "ci", "version"]
步骤 9：验证生成的 README

生成 README 后，验证以下内容：

  1. 检查 Markdown 语法错误
  2. 确认所有链接均可访问（仅警告）
  3. 确保 shields.io URL 格式正确
  4. 确认 Logo/图片路径存在
步骤 10：报告配置结果

打印所做更改的摘要、README 的位置，以及建议的后续步骤（自定义功能说明、添加 Logo、运行其他 configure 命令）。

结果报告格式请参阅 REFERENCE.md。

指定 --style detailed 时，还需包含架构部分和 Mermaid 图、API 参考链接以及变更日志链接。详细风格模板请参阅 REFERENCE.md。

输出

提供：

  1. 按部分列出的合规报告
  2. 生成或更新后的 README.md 内容
  3. 检测到的项目元数据列表
  4. 改进建议（Logo、更多功能等）

Agentic 优化

情境命令
快速合规检查/configure:readme --check-only
自动修复所有问题/configure:readme --fix
最简 README/configure:readme --fix --style minimal
完整详细版 README/configure:readme --fix --style detailed
生成项目树tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst
检查 README 是否存在test -f README.md && echo "EXISTS" || echo "MISSING"

另请参阅

  • /configure:docs - 配置代码文档规范
  • /configure:github-pages - 设置文档托管
  • /configure:all - 运行所有合规检查
  • REFERENCE.md - README 模板、徽章参考、章节规范和合规检查清单

评论

支持 Markdown