mcpField
R
readme-blueprint-generator

readme-blueprint-generator

github.com/github开发40.5k9.7k 次安装今天更新
代码仓库

关于 readme-blueprint-generator

这是一个根据 .github/copilot 文档和 copilot-instructions.md 生成仓库 README 的提示词。它规定了架构、技术栈、入门步骤、开发规范、测试和贡献指南等章节。

主要功能

  1. 01分析 Copilot 文档文件
  2. 02生成结构化 README.md
  3. 03概述技术栈和架构
  4. 04加入设置说明和项目结构
  5. 05记录工作流、规范与测试

适用场景

  1. 01为有文档的仓库生成 README
  2. 02将项目指南整理为入门材料
  3. 03概述开发和测试实践

安装

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

$npx skills add https://github.com/github/awesome-copilot --skill readme-blueprint-generator

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

详细介绍

README 生成器提示词

通过分析 .github/copilot 目录中的文档文件以及 copilot-instructions.md 文件，为此仓库生成一份全面的 README.md。请按以下步骤操作：

  1. 扫描 .github/copilot 文件夹中的所有文件，例如：

    • Architecture
    • Code_Exemplars
    • Coding_Standards
    • Project_Folder_Structure
    • Technology_Stack
    • Unit_Tests
    • Workflow_Analysis

  2. 同时查看 .github 文件夹中的 copilot-instructions.md 文件

  3. 创建包含以下章节的 README.md：

项目名称与描述

  • 从文档中提取项目名称和主要目的
  • 包含对项目功能的简要描述

技术栈

  • 列出所使用的主要技术、语言和框架
  • 在可用时包含版本信息
  • 此信息主要来源于 Technology_Stack 文件

项目架构

  • 提供架构的高层概览
  • 如果文档中有描述，可考虑加入一个简单的示意图
  • 来源于 Architecture 文件

快速开始

  • 根据技术栈包含安装说明
  • 添加设置和配置步骤
  • 包含任何前置条件

项目结构

  • 简要概述文件夹组织方式
  • 来源于 Project_Folder_Structure 文件

核心功能

  • 列出项目的主要功能和特性
  • 从各类文档文件中提取

开发工作流

  • 概述开发流程
  • 在可用时包含有关分支策略的信息
  • 来源于 Workflow_Analysis 文件

编码规范

  • 概述关键编码规范和约定
  • 来源于 Coding_Standards 文件

测试

  • 说明测试方法和工具
  • 来源于 Unit_Tests 文件

贡献指南

  • 为项目贡献的指南
  • 参考任何代码示例以获取指导
  • 来源于 Code_Exemplars 和 copilot-instructions

许可证

  • 在可用时包含许可证信息

使用规范的 Markdown 格式化 README，包括：

  • 清晰的标题和子标题
  • 在适当处使用代码块
  • 使用列表以提高可读性
  • 指向其他文档文件的链接
  • 在信息可用时添加构建状态、版本等徽章

保持 README 简洁而信息丰富，重点放在新开发者或用户需要了解的项目内容上。

评论

支持 Markdown