用途:为 .NET 项目生成符合 GitHub 惯例的原生文档与仓库元数据,方便贡献者与使用者快速上手。\n\n主要能力:\n1. README 结构,顶部按类别放徽章(NuGet 版本与下载量、构建状态、代码覆盖率、许可证、.NET 版本),并含安装、快速开始、功能、文档、架构、贡献、许可证、变更日志等章节。\n2. README 中直接嵌入 Mermaid 架构图,GitHub 可原生渲染。\n3. CONTRIBUTING.md,含 fork-PR 工作流、开发环境准备、构建与测试命令、编码规范、PR 流程。\n4. Issue 模板:bug 报告(要求 .NET 版本、复现步骤等)、功能请求(问题/方案/替代方案/API 表面)、提问模板及 config.yml。\n5. PR 模板,含变更类型、测试清单、破坏性变更、关联 issue。\n6. GitHub Pages 仓库侧配置(Settings 中 Source 选 GitHub Actions、docs/ 目录结构、CNAME 自定义域名)。\n7. 仓库元数据:CODEOWNERS、FUNDING.yml、社交预览图、topics/标签、仓库描述。\n\n使用方式:按资料给出的文件路径放置内容,例如 issue 模板置于 .github/ISSUE_TEMPLATE/,PR 模板文件名固定为 pull_request_template.md;示例常用命令保持原样,如 dotnet restore、dotnet build、dotnet test、dotnet test --collect:"XPlat Code Coverage"、dotnet build -warnaserror、dotnet add package My.Library。\n\n适用场景:.NET 库、SDK、框架类开源或内部仓库的文档规范建设。\n\n限制:不负责 GitHub Pages 的 CI/CD 部署工作流、变更日志与发布版本管理、文档平台选型、Mermaid 语法细节和项目文件结构。版本假设为 .NET 8.0+,CI 徽章基于 GitHub Actions,包徽章基于 NuGet.org;具体定价、平台支持与效果资料未提供。
dotnet-github-docs
前端与建站
更新于 10-16 07:23