From d583e3bf16c71d8f872974e95efa78e7ef2dd092 Mon Sep 17 00:00:00 2001 From: Xi Xu Date: Fri, 2 Jan 2026 15:51:18 +0800 Subject: [PATCH] Revamp and expand GitHub issue templates Major overhaul of issue templates: updated bug, feature, and performance templates for clarity and completeness; added new templates for documentation and platform requests; removed deprecated deployment and platform support templates; improved categorization, user guidance, and required fields. Updated config to point to new documentation and security links. Removed obsolete scripts/README.md. --- .github/ISSUE_TEMPLATE/bug_report.yml | 199 ++++++----- .github/ISSUE_TEMPLATE/config.yml | 14 +- .github/ISSUE_TEMPLATE/deployment_help.yml | 201 ----------- .github/ISSUE_TEMPLATE/documentation.yml | 172 +++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 213 ++++++----- .github/ISSUE_TEMPLATE/performance_issue.yml | 351 ++++++++++--------- .github/ISSUE_TEMPLATE/platform_request.yml | 233 ++++++++++++ .github/ISSUE_TEMPLATE/platform_support.yml | 199 ----------- .github/pull_request_template.md | 255 ++++---------- scripts/README.md | 39 --- 10 files changed, 904 insertions(+), 972 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/deployment_help.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/platform_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/platform_support.yml delete mode 100644 scripts/README.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9723dee..3104b2d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ -name: 🐛 错误报告 -description: 报告一个错误以帮助我们改进 -title: "[BUG] " +name: 🐛 Bug 报告 +description: 报告一个问题或错误 +title: "[Bug]: " labels: ["bug", "需要分类"] assignees: [] @@ -8,36 +8,61 @@ body: - type: markdown attributes: value: | - 感谢您花时间填写错误报告！请提供尽可能详细的信息以帮助我们快速定位和解决问题。 + 感谢你花时间填写这个 Bug 报告！请尽可能详细地描述问题，这将帮助我们更快地定位和修复问题。 + + - type: checkboxes + id: prerequisites + attributes: + label: 前置检查 + description: 在提交 Issue 之前，请确认以下事项 + options: + - label: 我已经搜索过现有的 Issues，确认这不是重复问题 + required: true + - label: 我已经查看过文档和 README + required: true + - label: 我使用的是最新版本的 Xget + required: false - type: textarea - id: bug-description + id: description attributes: - label: 错误描述 - description: 清楚简洁地描述这个错误是什么 - placeholder: 描述您遇到的问题... + label: 问题描述 + description: 清晰简洁地描述遇到的问题 + placeholder: 描述你遇到了什么问题... validations: required: true - type: textarea - id: reproduction-steps + id: reproduction attributes: label: 重现步骤 - description: 重现此行为的步骤 + description: 提供重现问题的详细步骤 placeholder: | 1. 访问 '...' - 2. 点击 '....' - 3. 滚动到 '....' - 4. 看到错误 + 2. 执行命令 '...' + 3. 观察到错误 '...' + value: | + 1. + 2. + 3. validations: required: true - type: textarea - id: expected-behavior + id: expected attributes: - label: 预期行为 - description: 清楚简洁地描述您期望发生什么 - placeholder: 描述您期望的正确行为... + label: 期望行为 + description: 描述你期望发生什么 + placeholder: 应该... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: 实际行为 + description: 描述实际发生了什么 + placeholder: 但实际上... validations: required: true @@ -45,102 +70,98 @@ body: id: platform attributes: label: 受影响的平台 - description: 选择出现问题的平台 + description: 选择问题相关的平台（可多选） + multiple: true options: - GitHub - GitLab - - Hugging Face - npm - PyPI - - conda - - 其他 - multiple: true + - Docker Hub + - crates.io + - Maven Central + - Homebrew + - Jenkins + - OpenAI API + - Anthropic API + - 其他 AI 推理 API + - 不确定/不适用 validations: required: true - - type: input - id: url-example - attributes: - label: 问题 URL 示例 - description: 提供出现问题的具体 URL - placeholder: https://xget.xi-xu.me/gh/... - validations: - required: false - - type: dropdown - id: operation-type + id: request_type attributes: - label: 操作类型 - description: 选择您执行的操作类型 + label: 请求类型 + description: 选择问题相关的请求类型 options: - - 文件下载 - - Git 克隆 - - Git 推送 - - Git 拉取 - - 包管理器使用 + - Git 克隆/拉取 + - Git LFS + - Docker 镜像拉取 + - 包下载 (npm/PyPI/Maven 等) + - AI API 推理请求 - 其他 validations: required: true - type: textarea - id: error-message + id: environment attributes: - label: 错误信息 - description: 如果有错误信息，请粘贴在这里 + label: 环境信息 + description: 提供你的环境详细信息 + value: | + - 操作系统: [例如 Ubuntu 22.04, macOS 14, Windows 11] + - 客户端工具: [例如 git 2.40, docker 24.0, npm 10.2] + - 浏览器 (如适用): [例如 Chrome 120, Firefox 121] + - Xget 部署方式: [Cloudflare Workers / 自托管 / 其他] + validations: + required: true + + - type: textarea + id: logs + attributes: + label: 错误日志 + description: | + 提供相关的错误日志、堆栈跟踪或控制台输出 + 提示: 你可以在代码块中粘贴日志以保持格式 render: shell - placeholder: 粘贴完整的错误信息... - validations: - required: false - - - type: dropdown - id: browsers - attributes: - label: 浏览器/工具 - description: 您使用的是什么浏览器或下载工具？ - options: - - Chrome - - Firefox - - Safari - - Edge - - wget - - curl - - aria2 - - git - - npm - - pip - - conda - - 其他 - multiple: true - validations: - required: false - - - type: input - id: instance-url - attributes: - label: 实例 URL - description: 您使用的 Xget 实例 URL - placeholder: https://xget.xi-xu.me 或您自己的实例 - validations: - required: false + placeholder: | + 粘贴错误日志... - type: textarea - id: additional-context + id: curl + attributes: + label: cURL 命令或请求示例 + description: 如果可能，提供能重现问题的 cURL 命令或请求示例（请移除敏感信息） + render: shell + placeholder: | + curl -X GET "https://your-xget-instance/gh/microsoft/vscode" -H "User-Agent: git/2.40" + + - type: textarea + id: additional attributes: label: 附加信息 - description: 添加关于问题的任何其他信息 - placeholder: 任何可能有助于解决问题的额外信息... + description: | + 提供任何其他有助于理解问题的上下文、截图或信息 + 提示: 你可以拖拽图片到这里上传 + + - type: dropdown + id: severity + attributes: + label: 严重程度 + description: 这个问题对你的影响有多大？ + options: + - 严重 - 核心功能完全无法使用 + - 高 - 重要功能受阻 + - 中 - 功能可用但有明显问题 + - 低 - 轻微问题或不便 validations: - required: false + required: true - type: checkboxes - id: terms + id: contribution attributes: - label: 确认 - description: 在提交之前，请确认以下内容 + label: 贡献意愿 + description: 你是否愿意提交 PR 来修复这个问题？ options: - - label: 我已经搜索了现有的 issues，确认这不是重复报告 - required: true - - label: 我已经阅读了存储库文档和故障排除指南 - required: true - - label: 我提供的信息准确且完整 - required: true + - label: 我愿意提交 PR 来修复这个问题 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 578f644..c665913 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ blank_issues_enabled: false contact_links: - - name: 📚 存储库文档 - url: https://github.com/xixu-me/Xget/blob/main/README.md - about: 查看完整的存储库文档和使用指南 + - name: 📚 文档 + url: https://github.com/xixu-me/Xget/blob/main/README.zh-Hans.md + about: 查看存储库的 README 文档 - name: 🌐 URL 转换器 url: https://xuc.xi-xu.me - about: 访问官方 web 应用程序，开箱即用 - - name: 🔧 故障排除 - url: https://github.com/xixu-me/Xget/blob/main/README.md#-故障排除 - about: 查看常见问题和解决方案 + about: 访问配套 web 应用程序 + - name: 🔐 安全漏洞报告 + url: https://github.com/xixu-me/xget/security/policy#-%E6%8A%A5%E5%91%8A%E5%AE%89%E5%85%A8%E6%BC%8F%E6%B4%9E + about: 报告安全漏洞 diff --git a/.github/ISSUE_TEMPLATE/deployment_help.yml b/.github/ISSUE_TEMPLATE/deployment_help.yml deleted file mode 100644 index b4367b0..0000000 --- a/.github/ISSUE_TEMPLATE/deployment_help.yml +++ /dev/null @@ -1,201 +0,0 @@ -name: 🚀 部署帮助 -description: 获取部署相关的帮助 -title: "[DEPLOYMENT] " -labels: ["deployment", "help wanted"] -assignees: [] - -body: - - type: markdown - attributes: - value: | - 需要部署帮助？我们来协助您成功部署 Xget 实例！ - - - type: dropdown - id: deployment-type - attributes: - label: 部署类型 - description: 您想要进行哪种类型的部署？ - options: - - Cloudflare Workers (推荐) - - 自定义域名绑定 - - 企业内部部署 - - 开发环境搭建 - - 其他平台部署 - validations: - required: true - - - type: dropdown - id: experience-level - attributes: - label: 技术经验水平 - description: 您的技术背景如何？ - options: - - 初学者 - 刚开始学习 - - 中级 - 有一些经验 - - 高级 - 经验丰富 - - 专家 - 非常熟练 - validations: - required: true - - - type: textarea - id: current-issue - attributes: - label: 当前遇到的问题 - description: 详细描述您在部署过程中遇到的具体问题 - placeholder: 描述您遇到的具体问题、错误信息或困惑... - validations: - required: true - - - type: textarea - id: steps-taken - attributes: - label: 已尝试的步骤 - description: 列出您已经尝试过的步骤 - placeholder: | - 1. 我已经... - 2. 然后我尝试了... - 3. 接着我... - validations: - required: true - - - type: textarea - id: error-messages - attributes: - label: 错误信息 - description: 如果有错误信息，请完整粘贴 - render: shell - placeholder: 粘贴完整的错误信息... - validations: - required: false - - - type: dropdown - id: operating-system - attributes: - label: 操作系统 - description: 您使用的操作系统 - options: - - Windows - - macOS - - Linux (Ubuntu/Debian) - - Linux (CentOS/RHEL) - - Linux (其他发行版) - - 其他 - validations: - required: false - - - type: input - id: node-version - attributes: - label: Node.js 版本 - description: 您的 Node.js 版本（如果相关） - placeholder: 例如：v18.17.0 - validations: - required: false - - - type: input - id: npm-version - attributes: - label: npm 版本 - description: 您的 npm 版本（如果相关） - placeholder: 例如：9.6.7 - validations: - required: false - - - type: dropdown - id: cloudflare-account - attributes: - label: Cloudflare 账户状态 - description: 您的 Cloudflare 账户状态（如果使用 Cloudflare Workers） - options: - - 还没有账户 - - 有免费账户 - - 有付费账户 - - 不确定 - - 不使用 Cloudflare - validations: - required: false - - - type: textarea - id: custom-requirements - attributes: - label: 自定义需求 - description: 您是否有特殊的部署需求或配置要求？ - placeholder: | - 例如： - - 需要自定义域名 - - 需要特定的缓存策略 - - 需要企业级安全配置 - - 需要集成现有系统 - validations: - required: false - - - type: input - id: target-domain - attributes: - label: 目标域名 - description: 如果您计划使用自定义域名，请提供 - placeholder: 例如：xget.example.com - validations: - required: false - - - type: dropdown - id: expected-usage - attributes: - label: 预期使用量 - description: 您预期的使用量级别 - options: - - 个人使用 - 偶尔使用 - - 小团队 - 日常使用 - - 中型团队 - 频繁使用 - - 大型组织 - 高频使用 - - 公共服务 - 大量用户 - validations: - required: false - - - type: textarea - id: configuration-questions - attributes: - label: 配置相关问题 - description: 关于配置的具体问题 - placeholder: | - 例如： - - 如何修改缓存时间？ - - 如何添加新平台支持？ - - 如何配置安全策略？ - validations: - required: false - - - type: dropdown - id: urgency - attributes: - label: 紧急程度 - description: 您需要帮助的紧急程度 - options: - - 低 - 有时间慢慢解决 - - 中 - 希望尽快解决 - - 高 - 比较急需 - - 紧急 - 阻碍工作进展 - validations: - required: true - - - type: textarea - id: additional-context - attributes: - label: 附加信息 - description: 任何其他可能有助于提供帮助的信息 - placeholder: 其他相关信息、截图、配置文件内容等... - validations: - required: false - - - type: checkboxes - id: terms - attributes: - label: 确认 - description: 在提交之前，请确认以下内容 - options: - - label: 我已经阅读了存储库的 README 和部署文档 - required: true - - label: 我已经搜索了现有的 issues 寻找类似问题 - required: true - - label: 我提供的信息准确且完整 - required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..6cac3e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,172 @@ +name: 📝 文档改进 +description: 报告文档问题或建议文档改进 +title: "[Docs]: " +labels: ["documentation", "需要分类"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + 感谢你帮助改进文档！清晰准确的文档对存储库至关重要。 + + - type: dropdown + id: doc_type + attributes: + label: 文档类型 + description: 这涉及哪种类型的文档？ + options: + - README + - CLAUDE.md + - API 文档 + - 部署指南 + - 配置说明 + - 使用教程 + - 开发文档 + - 代码注释 + - 其他 + validations: + required: true + + - type: dropdown + id: issue_category + attributes: + label: 问题类别 + description: 选择文档问题的类别 + options: + - 内容缺失 + - 内容过时 + - 内容错误 + - 不够清晰 + - 示例缺失 + - 示例错误 + - 格式问题 + - 翻译问题 + - 组织结构问题 + - 新内容建议 + validations: + required: true + + - type: textarea + id: location + attributes: + label: 文档位置 + description: 指出具体的文档位置 + placeholder: | + - 文件: README.md + - 章节: "部署到 Cloudflare Workers" + - 行号: 约 L123-L145 + - URL: https://github.com/.../blob/main/... + validations: + required: true + + - type: textarea + id: current_content + attributes: + label: 当前内容 + description: 引用当前的文档内容（如果适用） + placeholder: | + 当前文档中写的是: + > "..." + render: markdown + + - type: textarea + id: issue_description + attributes: + label: 问题描述 + description: 详细描述文档存在的问题 + placeholder: | + 这个文档有以下问题: + 1. + 2. + validations: + required: true + + - type: textarea + id: suggested_content + attributes: + label: 建议的改进 + description: 提供具体的改进建议或修正后的内容 + placeholder: | + 建议改为: + "..." + + 或者添加以下内容: + "..." + render: markdown + validations: + required: true + + - type: textarea + id: why_important + attributes: + label: 重要性说明 + description: 解释为什么这个改进很重要 + placeholder: | + 这个改进很重要因为: + - 现在的文档导致用户... + - 这是新用户常见的困惑点... + - 可以帮助用户更快地... + + - type: textarea + id: user_perspective + attributes: + label: 用户视角 + description: 从哪种用户的角度看这个文档问题？ + placeholder: | + - 新用户首次部署 + - 开发者集成 Xget + - 贡献者了解代码结构 + - 运维人员配置环境 + + - type: textarea + id: examples + attributes: + label: 示例需求 + description: 如果需要添加示例，请描述所需的示例类型 + placeholder: | + 希望添加以下示例: + - Git 克隆的完整命令示例 + - Docker 拉取镜像的配置示例 + - 环境变量配置的实际案例 + + - type: checkboxes + id: language + attributes: + label: 语言版本 + description: 这个问题涉及哪些语言版本？（可多选） + options: + - label: 中文文档 + - label: 英文文档 + - label: 其他语言 + + - type: checkboxes + id: related_areas + attributes: + label: 相关领域 + description: 这个文档改进可能涉及哪些领域？（可多选） + options: + - label: 快速开始指南 + - label: 安装部署 + - label: 配置说明 + - label: 平台使用 + - label: API 参考 + - label: 故障排查 + - label: 性能优化 + - label: 安全配置 + - label: 开发贡献 + - label: 架构设计 + + - type: checkboxes + id: contribution + attributes: + label: 贡献意愿 + options: + - label: 我愿意提交 PR 来改进这个文档 + - label: 我可以帮助审阅文档改进 + + - type: textarea + id: additional + attributes: + label: 附加信息 + description: 提供任何其他有助于改进文档的信息或建议 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index ff9e8ef..77002e3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: ✨ 功能请求 -description: 为这个存储库建议一个想法 -title: "[FEATURE] " +description: 建议一个新功能或改进 +title: "[Feature]: " labels: ["enhancement", "需要分类"] assignees: [] @@ -8,124 +8,161 @@ body: - type: markdown attributes: value: | - 感谢您提出功能建议！我们重视每一个改进建议，请详细描述您的想法。 + 感谢你提出新功能建议！请详细描述你的想法，这将帮助我们更好地评估和实现。 - - type: textarea - id: problem-description + - type: checkboxes + id: prerequisites attributes: - label: 问题描述 - description: 您的功能请求是否与某个问题相关？请清楚简洁地描述问题是什么 - placeholder: 我在使用时遇到了困扰，因为... - validations: - required: true - - - type: textarea - id: solution-description - attributes: - label: 解决方案描述 - description: 清楚简洁地描述您希望实现的功能 - placeholder: 我希望能够... - validations: - required: true + label: 前置检查 + description: 在提交功能请求之前，请确认以下事项 + options: + - label: 我已经搜索过现有的 Issues 和 PR，确认这不是重复请求 + required: true + - label: 我已经查看过存储库文档 + required: true - type: dropdown - id: feature-category + id: feature_type attributes: - label: 功能类别 - description: 这个功能属于哪个类别？ + label: 功能类型 + description: 这个请求属于什么类型？ options: - - 性能优化 - 新平台支持 + - 新协议支持 + - 性能优化 + - 缓存改进 - 安全增强 - - 用户体验改进 - - API 功能 + - 监控/日志功能 - 配置选项 - - 监控和日志 + - API 改进 - 文档改进 + - 开发体验改进 - 其他 validations: required: true + - type: textarea + id: problem + attributes: + label: 问题背景 + description: 描述你想解决的问题或痛点 + placeholder: | + 我在使用 Xget 时遇到了... + 当前的方式是...，但是... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: 建议的解决方案 + description: 清晰地描述你希望实现的功能 + placeholder: 我希望 Xget 能够... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: 备选方案 + description: 描述你考虑过的其他替代解决方案 + placeholder: | + 我也考虑过... + 但这个方案的问题是... + + - type: textarea + id: use_case + attributes: + label: 使用场景 + description: 描述具体的使用场景和预期效果 + placeholder: | + 场景 1: 当用户...时，这个功能可以... + 场景 2: 在...情况下，能够... + validations: + required: true + - type: dropdown id: priority attributes: label: 优先级 - description: 您认为这个功能的优先级如何？ + description: 这个功能对你有多重要？ options: - - 低 - 有了更好 - - 中 - 会很有用 - - 高 - 非常需要 - - 紧急 - 阻碍使用 + - 高 - 对我的工作流程至关重要 + - 中 - 会显著改善使用体验 + - 低 - 有更好，但不是必需的 validations: required: true - type: textarea - id: alternatives + id: platform_specific attributes: - label: 替代方案 - description: 清楚简洁地描述您考虑过的任何替代解决方案或功能 - placeholder: 我也考虑过... - validations: - required: false - - - type: textarea - id: use-cases - attributes: - label: 使用场景 - description: 描述这个功能的具体使用场景和受益用户群体 + label: 特定平台需求 + description: 如果这是平台相关的功能请求，请提供详细信息 placeholder: | - 这个功能将帮助： - - 开发者在...场景下 - - 企业用户需要... - - 个人用户想要... - validations: - required: true + - 平台名称: + - 平台 URL: + - API 文档: + - 认证方式: + - 特殊要求: - type: textarea - id: implementation-ideas + id: technical_details attributes: - label: 实现想法 - description: 如果您有关于如何实现这个功能的想法，请分享 - placeholder: 可能的实现方式... - validations: - required: false - - - type: dropdown - id: affected-platforms - attributes: - label: 涉及平台 - description: 这个功能涉及哪些平台？ - options: - - 所有平台 - - GitHub - - GitLab - - Hugging Face - - npm - - PyPI - - conda - - 新平台 - multiple: true - validations: - required: false + label: 技术细节 + description: 如果你有技术实现建议，请在此描述 + placeholder: | + 实现方式可能包括: + 1. 在 platforms.js 中添加... + 2. 需要处理...协议 + 3. 可能的挑战是... - type: textarea - id: additional-context + id: examples attributes: - label: 附加信息 - description: 添加关于功能请求的任何其他信息、截图或示例 - placeholder: 任何有助于理解功能需求的额外信息... - validations: - required: false + label: 示例和参考 + description: 提供相关的示例、链接或参考实现 + placeholder: | + - 类似实现: + - 官方文档: + - 示例请求: - type: checkboxes - id: terms + id: impact attributes: - label: 确认 - description: 在提交之前，请确认以下内容 + label: 影响范围 + description: 这个功能可能影响哪些方面？（可多选） options: - - label: 我已经搜索了现有的 issues，确认这不是重复请求 - required: true - - label: 我已经阅读了存储库文档，确认此功能尚未存在 - required: true - - label: 这个功能符合存储库的目标和范围 - required: true + - label: 核心请求处理逻辑 + - label: 平台配置 + - label: 协议处理 + - label: 缓存策略 + - label: 安全性 + - label: 性能 + - label: 配置选项 + - label: 文档 + - label: 部署流程 + + - type: checkboxes + id: breaking + attributes: + label: 破坏性变更 + description: 这个功能是否可能引入破坏性变更？ + options: + - label: 可能需要破坏性变更 + - label: 向后兼容 + + - type: checkboxes + id: contribution + attributes: + label: 贡献意愿 + description: 你是否愿意参与实现这个功能？ + options: + - label: 我愿意提交 PR 来实现这个功能 + - label: 我可以提供测试和反馈 + - label: 我可以帮助编写文档 + + - type: textarea + id: additional + attributes: + label: 附加信息 + description: 提供任何其他有助于理解这个功能请求的信息 diff --git a/.github/ISSUE_TEMPLATE/performance_issue.yml b/.github/ISSUE_TEMPLATE/performance_issue.yml index b7d72e8..919db6c 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.yml +++ b/.github/ISSUE_TEMPLATE/performance_issue.yml @@ -1,6 +1,6 @@ name: ⚡ 性能问题 -description: 报告性能相关的问题 -title: "[PERFORMANCE] " +description: 报告性能相关的问题或建议性能优化 +title: "[Performance]: " labels: ["performance", "需要分类"] assignees: [] @@ -8,198 +8,229 @@ body: - type: markdown attributes: value: | - 感谢您报告性能问题！性能数据对我们优化服务非常重要。 + 感谢你报告性能问题！请提供详细的性能指标和场景，这将帮助我们诊断和优化。 - - type: textarea - id: performance-issue + - type: checkboxes + id: prerequisites attributes: - label: 性能问题描述 - description: 详细描述您遇到的性能问题 - placeholder: 描述具体的性能问题，如下载速度慢、响应时间长等... - validations: - required: true + label: 前置检查 + options: + - label: 我已经搜索过现有的性能相关 Issues + required: true + - label: 我已经确认这不是上游平台本身的性能问题 + required: true - type: dropdown - id: issue-type + id: issue_type attributes: label: 问题类型 description: 选择性能问题的类型 options: - - 下载速度慢 - - 响应时间长 - - 连接超时 - - 频繁重试 + - 响应时间过长 + - 超时错误 + - 高延迟 + - 带宽限制 - 缓存未命中 - - Git 操作缓慢 + - 内存使用过高 + - 并发性能问题 - 其他 validations: required: true - type: dropdown - id: affected-platform + id: affected_platform attributes: label: 受影响的平台 - description: 选择出现性能问题的平台 + description: 哪个平台的性能出现问题？ options: - GitHub - GitLab - - Hugging Face - npm - PyPI - - conda + - Docker Hub + - crates.io + - Maven Central + - Homebrew + - Jenkins + - OpenAI API + - Anthropic API + - 多个平台 - 所有平台 - multiple: true validations: required: true - - type: input - id: file-size + - type: dropdown + id: operation_type attributes: - label: 文件大小 - description: 如果涉及文件下载，请提供文件大小 - placeholder: 例如：100MB, 1.5GB + label: 操作类型 + description: 什么类型的操作性能有问题？ + options: + - Git 克隆 + - Git 拉取 + - Git LFS 下载 + - Docker 镜像拉取 + - 包下载 + - AI API 请求 + - 元数据获取 + - 其他 validations: - required: false - - - type: input - id: download-speed - attributes: - label: 实际下载速度 - description: 您观察到的下载速度 - placeholder: 例如：500KB/s, 2MB/s - validations: - required: false - - - type: input - id: expected-speed - attributes: - label: 期望下载速度 - description: 您期望的下载速度或直接访问源站的速度 - placeholder: 例如：10MB/s, 50MB/s - validations: - required: false + required: true - type: textarea - id: performance-metrics + id: description + attributes: + label: 问题描述 + description: 详细描述性能问题 + placeholder: | + 在执行...操作时，性能明显低于预期... + 相比直接访问上游，速度慢了... + validations: + required: true + + - type: textarea + id: metrics attributes: label: 性能指标 - description: 如果您有具体的性能数据，请提供（如响应头中的 X-Performance-Metrics） - render: json - placeholder: 粘贴性能指标数据... - validations: - required: false - - - type: input - id: test-url - attributes: - label: 测试 URL - description: 提供出现性能问题的具体 URL - placeholder: https://xget.xi-xu.me/gh/... - validations: - required: false - - - type: dropdown - id: geographic-location - attributes: - label: 地理位置 - description: 您的大致地理位置（有助于分析 CDN 性能） - options: - - 中国大陆 - - 中国香港 - - 中国台湾 - - 日本 - - 韩国 - - 新加坡 - - 美国西海岸 - - 美国东海岸 - - 欧洲 - - 其他亚洲地区 - - 其他地区 - validations: - required: false - - - type: dropdown - id: network-type - attributes: - label: 网络类型 - description: 您使用的网络类型 - options: - - 家庭宽带 - - 企业网络 - - 移动网络 (4G) - - 移动网络 (5G) - - 公共 WiFi - - VPN - - 其他 - validations: - required: false - - - type: input - id: bandwidth - attributes: - label: 网络带宽 - description: 您的网络带宽 - placeholder: 例如：100Mbps, 1Gbps - validations: - required: false - - - type: dropdown - id: tool-used - attributes: - label: 使用的工具 - description: 您使用什么工具进行下载或操作？ - options: - - 浏览器下载 - - wget - - curl - - aria2 - - git - - npm - - pip - - conda - - 其他 - validations: - required: false - - - type: input - id: instance-url - attributes: - label: 实例 URL - description: 您使用的 Xget 实例 - placeholder: https://xget.xi-xu.me 或您自己的实例 - validations: - required: false - - - type: textarea - id: comparison-test - attributes: - label: 对比测试 - description: 如果您进行了对比测试（如直接访问源站），请提供结果 + description: 提供具体的性能数据 placeholder: | - 直接访问源站速度：... - 通过 Xget 访问速度：... - 测试时间：... + - 响应时间: XX ms (预期 < YY ms) + - 下载速度: XX KB/s (上游直连: YY KB/s) + - 首字节时间 (TTFB): XX ms + - 总耗时: XX 秒 + - X-Performance-Metrics 头信息: {...} + render: markdown validations: - required: false + required: true - type: textarea - id: additional-context + id: reproduction + attributes: + label: 重现步骤 + description: 提供详细的重现步骤和测试命令 + render: shell + placeholder: | + # 测试命令 + time git clone https://your-xget-instance/gh/user/repo + + # 或使用 curl 测试 + curl -w "@curl-format.txt" -o /dev/null https://your-xget-instance/... + validations: + required: true + + - type: textarea + id: environment + attributes: + label: 环境信息 + description: 提供详细的环境信息 + value: | + - Xget 部署方式: [Cloudflare Workers / 自托管 / ...] + - Xget 区域: [US/EU/ASIA/...] + - 客户端位置: [国家/地区] + - 网络环境: [家庭宽带 / 公司网络 / VPS / ...] + - ISP: + - 客户端工具版本: + - 操作系统: + validations: + required: true + + - type: textarea + id: resource_size + attributes: + label: 资源规模 + description: 描述涉及的资源大小 + placeholder: | + - 存储库大小: XX MB + - 文件数量: XX 个 + - 单个文件大小: XX MB + - Docker 镜像大小: XX GB + - 镜像层数: XX 层 + + - type: textarea + id: comparison + attributes: + label: 性能对比 + description: 对比 Xget 与直接访问上游的性能差异 + placeholder: | + | 操作 | 通过 Xget | 直接访问上游 | 差异 | + |------|-----------|--------------|------| + | 克隆 | 30s | 10s | +200% | + | 拉取 | 5s | 2s | +150% | + render: markdown + + - type: textarea + id: cache_info + attributes: + label: 缓存信息 + description: 检查响应的缓存相关 Header + placeholder: | + - CF-Cache-Status: + - X-Cache-Status: + - Age: + - Cache-Control: + render: markdown + + - type: textarea + id: network_trace + attributes: + label: 网络追踪 + description: 如果可能，提供网络追踪信息（如 curl -v 输出的关键部分） + render: shell + placeholder: | + * Connected to your-xget-instance (...) + * TLS handshake... + < HTTP/2 200 + < x-performance-metrics: {...} + + - type: dropdown + id: frequency + attributes: + label: 问题频率 + description: 这个性能问题多久发生一次？ + options: + - 每次都发生 + - 经常发生 (>50%) + - 偶尔发生 (10-50%) + - 很少发生 (<10%) + validations: + required: true + + - type: dropdown + id: impact + attributes: + label: 影响程度 + description: 这个性能问题的影响有多大？ + options: + - 严重 - 完全无法使用 + - 高 - 严重影响工作效率 + - 中 - 造成明显不便 + - 低 - 轻微影响 + validations: + required: true + + - type: textarea + id: expected_performance + attributes: + label: 期望的性能 + description: 描述你期望的性能指标 + placeholder: | + - 理想响应时间: < 100ms + - 可接受的下载速度: > 1MB/s + - 目标改进: 减少 50% 的延迟 + + - type: textarea + id: suggestions + attributes: + label: 优化建议 + description: 如果你有优化建议，请在此描述 + placeholder: | + 可能的优化方向: + - 增加缓存时长 + - 使用流式传输 + - 优化重试策略 + - ... + + - type: textarea + id: additional attributes: label: 附加信息 - description: 任何其他可能有助于诊断性能问题的信息 - placeholder: 其他相关信息... - validations: - required: false - - - type: checkboxes - id: terms - attributes: - label: 确认 - description: 在提交之前，请确认以下内容 - options: - - label: 我已经尝试了多次测试以确认问题的一致性 - required: true - - label: 我已经检查了网络连接和本地环境 - required: true - - label: 我提供的性能数据准确可靠 - required: true + description: 提供任何其他有助于诊断性能问题的信息 diff --git a/.github/ISSUE_TEMPLATE/platform_request.yml b/.github/ISSUE_TEMPLATE/platform_request.yml new file mode 100644 index 0000000..7c41781 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/platform_request.yml @@ -0,0 +1,233 @@ +name: 🌐 新平台支持请求 +description: 请求添加对新平台的支持 +title: "[Platform]: " +labels: ["platform", "enhancement", "需要分类"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + 感谢你提出新平台支持请求！请提供尽可能详细的平台信息，以便我们评估和实现。 + + - type: checkboxes + id: prerequisites + attributes: + label: 前置检查 + options: + - label: 我已经搜索过现有的 Issues，确认这个平台还未被请求或支持 + required: true + - label: 这个平台是公开可访问的服务 + required: true + + - type: input + id: platform_name + attributes: + label: 平台名称 + description: 请提供平台的官方名称 + placeholder: 例如: GitLab, Bitbucket, Quay.io + validations: + required: true + + - type: input + id: platform_url + attributes: + label: 平台 URL + description: 平台的主要域名或网址 + placeholder: 例如: https://registry.example.com + validations: + required: true + + - type: dropdown + id: platform_category + attributes: + label: 平台类别 + description: 这个平台属于什么类别？ + options: + - 代码存储库 (Git) + - 容器注册表 (Docker/OCI) + - 软件包注册表 (npm/PyPI/Maven 等) + - AI 推理提供商 + - CDN/文件存储 + - 其他 + validations: + required: true + + - type: textarea + id: platform_description + attributes: + label: 平台描述 + description: 简要描述这个平台的用途和特点 + placeholder: 这个平台是一个...，主要用于... + validations: + required: true + + - type: textarea + id: use_case + attributes: + label: 使用场景 + description: 为什么需要加速这个平台？具体的使用场景是什么？ + placeholder: | + 在中国大陆访问该平台时... + 我的团队经常需要从该平台下载... + 加速该平台可以帮助... + validations: + required: true + + - type: textarea + id: api_documentation + attributes: + label: API 文档 + description: 提供平台的 API 文档链接（如果有） + placeholder: | + - 官方 API 文档: + - 认证文档: + - 其他相关文档: + + - type: dropdown + id: authentication + attributes: + label: 认证方式 + description: 该平台使用什么认证方式？ + options: + - 无需认证（公开访问） + - API Token + - OAuth 2.0 + - Basic Auth + - Bearer Token + - 自定义认证 + - 不确定 + validations: + required: true + + - type: textarea + id: auth_details + attributes: + label: 认证详情 + description: 如果需要认证，请提供详细的认证流程说明 + placeholder: | + 该平台的认证流程: + 1. + 2. + 3. + + - type: dropdown + id: protocol + attributes: + label: 主要协议 + description: 访问该平台主要使用什么协议？ + options: + - HTTP/HTTPS (RESTful API) + - Git Protocol + - Docker Registry V2 + - OCI Distribution Spec + - 其他/混合 + validations: + required: true + + - type: textarea + id: url_structure + attributes: + label: URL 结构示例 + description: 提供该平台的典型 URL 结构和示例 + placeholder: | + 示例 URL: + - 下载包: https://example.com/packages/{name}/{version} + - 存储库克隆: https://example.com/repos/{owner}/{repo}.git + - API 端点: https://api.example.com/v1/... + render: markdown + validations: + required: true + + - type: textarea + id: special_requirements + attributes: + label: 特殊要求 + description: 该平台是否有特殊的 Header、参数或处理要求？ + placeholder: | + - 必需的 Headers: + - 特殊的查询参数: + - 响应格式: + - URL 重写需求: + - 其他特殊处理: + + - type: textarea + id: request_examples + attributes: + label: 请求示例 + description: 提供一些典型的请求示例（请移除敏感信息） + render: shell + placeholder: | + # 示例 1: 获取包信息 + curl -X GET "https://example.com/api/packages/foo" + + # 示例 2: 下载文件 + curl -X GET "https://example.com/files/bar.tar.gz" + + - type: textarea + id: response_examples + attributes: + label: 响应示例 + description: 提供典型响应的示例（可以是简化版本） + render: json + placeholder: | + { + "name": "example-package", + "version": "1.0.0", + "download_url": "https://example.com/files/..." + } + + - type: textarea + id: challenges + attributes: + label: 潜在挑战 + description: 你认为支持这个平台可能遇到哪些挑战？ + placeholder: | + - 该平台使用自定义的认证方式... + - URL 结构比较复杂... + - 需要处理特殊的重定向... + + - type: textarea + id: similar_platforms + attributes: + label: 类似平台 + description: 列出 Xget 已支持的类似平台（如果有） + placeholder: | + 这个平台类似于已支持的: + - npm (软件包注册表) + - Docker Hub (容器注册表) + + - type: input + id: estimated_users + attributes: + label: 用户基数 + description: 该平台的大致用户规模或你所在团队/社区的使用情况 + placeholder: 例如: 国内有约 XX 万开发者使用，我的团队有 20 人使用 + + - type: dropdown + id: priority + attributes: + label: 优先级 + description: 这个平台支持对你有多重要？ + options: + - 高 - 我们团队急需 + - 中 - 会显著改善工作流程 + - 低 - 有更好，但不紧急 + validations: + required: true + + - type: checkboxes + id: contribution + attributes: + label: 贡献意愿 + options: + - label: 我愿意提供该平台的测试账号（如果需要） + - label: 我愿意协助测试平台支持 + - label: 我愿意提交 PR 来实现平台支持 + - label: 我可以提供更多技术文档和细节 + + - type: textarea + id: additional + attributes: + label: 附加信息 + description: 提供任何其他有助于实现这个平台支持的信息 diff --git a/.github/ISSUE_TEMPLATE/platform_support.yml b/.github/ISSUE_TEMPLATE/platform_support.yml deleted file mode 100644 index d3acb10..0000000 --- a/.github/ISSUE_TEMPLATE/platform_support.yml +++ /dev/null @@ -1,199 +0,0 @@ -name: 🌐 平台支持请求 -description: 请求添加新平台支持 -title: "[PLATFORM] " -labels: ["platform", "enhancement"] -assignees: [] - -body: - - type: markdown - attributes: - value: | - 感谢您提出新平台支持请求！我们致力于支持更多有价值的平台。 - - - type: input - id: platform-name - attributes: - label: 平台名称 - description: 您希望支持的平台名称 - placeholder: 例如：Bitbucket, SourceForge, Codeberg - validations: - required: true - - - type: input - id: platform-url - attributes: - label: 平台 URL - description: 平台的主要 URL - placeholder: https://example.com - validations: - required: true - - - type: textarea - id: platform-description - attributes: - label: 平台描述 - description: 简要描述这个平台的用途和特点 - placeholder: 这是一个用于...的平台，主要特点是... - validations: - required: true - - - type: dropdown - id: platform-type - attributes: - label: 平台类型 - description: 选择平台的主要类型 - options: - - 代码托管 (Git) - - 包管理器 - - 模型/数据集托管 - - 文件存储 - - 容器镜像 - - 文档托管 - - 其他 - validations: - required: true - - - type: textarea - id: url-patterns - attributes: - label: URL 模式示例 - description: 提供该平台的典型 URL 模式示例 - placeholder: | - 文件下载：https://example.com/user/repo/releases/download/v1.0/file.zip - Git 克隆：https://example.com/user/repo.git - API 访问：https://api.example.com/v1/... - validations: - required: true - - - type: dropdown - id: supported-operations - attributes: - label: 需要支持的操作 - description: 选择需要支持的操作类型 - options: - - 文件下载 - - Git 克隆 - - Git 推送 - - API 访问 - - 包下载 - - 元数据获取 - - 其他 - multiple: true - validations: - required: true - - - type: textarea - id: authentication - attributes: - label: 认证要求 - description: 该平台是否需要特殊的认证方式？ - placeholder: | - - 是否需要 API Token？ - - 是否有公开访问的内容？ - - 认证方式是什么？ - validations: - required: false - - - type: textarea - id: rate-limits - attributes: - label: 速率限制 - description: 该平台是否有已知的速率限制或访问限制？ - placeholder: 例如：每小时 1000 次请求，需要 User-Agent 等 - validations: - required: false - - - type: dropdown - id: popularity - attributes: - label: 平台流行度 - description: 您认为这个平台的使用程度如何？ - options: - - 非常流行 - 广泛使用 - - 较为流行 - 有一定用户群体 - - 小众但重要 - 特定领域重要 - - 新兴平台 - 发展潜力大 - validations: - required: true - - - type: textarea - id: use-cases - attributes: - label: 使用场景 - description: 描述支持这个平台的主要使用场景和受益用户 - placeholder: | - 这个平台主要用于： - - 开发者需要... - - 企业用户使用它来... - - 学术研究中... - validations: - required: true - - - type: textarea - id: technical-challenges - attributes: - label: 技术挑战 - description: 您是否了解支持这个平台可能面临的技术挑战？ - placeholder: | - 可能的技术挑战： - - 特殊的 URL 结构 - - 复杂的认证流程 - - 特殊的请求头要求 - - 其他技术限制 - validations: - required: false - - - type: input - id: similar-platforms - attributes: - label: 类似平台 - description: 是否有已支持的类似平台可以参考？ - placeholder: 例如：类似于 GitHub 的功能 - validations: - required: false - - - type: textarea - id: documentation - attributes: - label: 相关文档 - description: 提供该平台的 API 文档或开发者文档 URL - placeholder: | - - API 文档：https://... - - 开发者指南：https://... - - 其他相关资源：https://... - validations: - required: false - - - type: dropdown - id: priority-level - attributes: - label: 优先级 - description: 您认为这个平台支持的优先级如何？ - options: - - 高 - 急需支持 - - 中 - 希望尽快支持 - - 低 - 有时间时支持 - validations: - required: true - - - type: textarea - id: additional-info - attributes: - label: 附加信息 - description: 任何其他有助于评估和实现平台支持的信息 - placeholder: 其他相关信息... - validations: - required: false - - - type: checkboxes - id: terms - attributes: - label: 确认 - description: 在提交之前，请确认以下内容 - options: - - label: 我已经确认该平台提供公开可访问的内容 - required: true - - label: 我了解该平台的使用条款和限制 - required: true - - label: 我提供的信息准确且完整 - required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1f7b16e..4e05c4b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,229 +1,106 @@ -# Pull Request +## 概述 -## 📋 变更概述 + -### 变更类型 +## 改动类型 -请选择适用的类型： + - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 -- [ ] 📚 文档更新 -- [ ] 🎨 代码格式化/重构 -- [ ] ⚡ 性能优化 -- [ ] 🧪 测试相关 -- [ ] 🔧 构建/配置更改 -- [ ] 🌐 新平台支持 +- [ ] 📝 文档更新 +- [ ] 🎨 代码风格/格式调整 +- [ ] ♻️ 代码重构 +- [ ] ⚡️ 性能优化 +- [ ] ✅ 测试相关 +- [ ] 🔧 配置文件修改 +- [ ] 🌐 新增平台支持 +- [ ] 🔒 安全相关 -### 变更描述 +## 相关 Issue -简要描述此 PR 的主要变更内容： + -### 相关 Issue +Closes # +Related to # -关联的 Issue 编号（如果有）： +## 改动说明 -- Closes # -- Fixes # -- Related to # + -## 🔍 详细说明 +### 主要改动 -### 变更内容 +- -详细描述您所做的更改： +### 技术细节 -### 实现方法 +- -说明您是如何实现这些更改的： +## 测试 -### 影响范围 + -这些更改会影响哪些部分： - -- [ ] 核心代理逻辑 -- [ ] 平台配置 -- [ ] 安全机制 -- [ ] 缓存策略 -- [ ] 性能监控 -- [ ] 文档 -- [ ] 测试 -- [ ] 其他： - -## 🧪 测试 +- [ ] 已通过所有现有测试 (`npm run test:run`) +- [ ] 已添加新的测试用例 +- [ ] 已在本地开发环境测试 (`npm run dev`) +- [ ] 已验证代码格式 (`npm run format:check`) +- [ ] 已通过类型检查 (`npm run type-check`) +- [ ] 已通过 lint 检查 (`npm run lint`) ### 测试环境 -- [ ] 本地开发环境 -- [ ] Cloudflare Workers 测试环境 -- [ ] 生产环境（如适用） + -### 测试用例 +- -描述您进行的测试： +## 影响范围 -#### 功能测试 + -- [ ] 基本功能正常工作 -- [ ] 边界情况处理正确 -- [ ] 错误处理机制有效 +- [ ] 核心请求处理逻辑 +- [ ] 平台配置 +- [ ] 协议处理 (Git/Docker/AI) +- [ ] 缓存策略 +- [ ] 安全功能 +- [ ] 性能监控 +- [ ] 文档 +- [ ] CI/CD 流程 -#### 平台测试（如适用） +## 破坏性变更 -- [ ] GitHub 文件下载 -- [ ] GitLab 文件下载 -- [ ] Hugging Face 模型下载 -- [ ] npm 包下载 -- [ ] PyPI 包下载 -- [ ] conda 包下载 -- [ ] Git 操作（clone/push/pull） + -#### 性能测试 +- [ ] 是 +- [ ] 否 -- [ ] 响应时间在可接受范围内 -- [ ] 缓存机制工作正常 -- [ ] 内存使用合理 +
+破坏性变更详情 -### 测试结果 + -提供测试结果或截图： +
-## 📝 检查清单 +## 部署说明 -### 代码质量 + -- [ ] 代码遵循存储库编码规范 -- [ ] 添加了必要的注释 -- [ ] 没有遗留的调试代码 -- [ ] 处理了所有可能的错误情况 +- -### 测试覆盖 +## 截图/演示 -- [ ] 为新功能添加了测试用例 -- [ ] 所有测试都通过 -- [ ] 测试覆盖率没有显著下降 + -### 文档更新 +## Checklist -- [ ] 更新了相关的 README 部分 -- [ ] 更新了 API 文档（如适用） -- [ ] 添加了使用示例（如适用） -- [ ] 更新了配置说明（如适用） +- [ ] 代码遵循存储库的编码规范 +- [ ] 已进行自我代码审查 +- [ ] 代码注释清晰，特别是复杂逻辑部分 +- [ ] 已更新相关文档 +- [ ] 改动不会产生新的警告 +- [ ] 已添加必要的测试，且测试通过 +- [ ] 新增和现有的单元测试都通过 +- [ ] 依赖的改动已合并并发布 -### 兼容性 +## 附加说明 -- [ ] 向后兼容现有功能 -- [ ] 不会破坏现有的 API -- [ ] 考虑了不同平台的兼容性 - -## 🚀 部署注意事项 - -### 配置变更 - -是否需要更新配置： - -- [ ] 无需配置变更 -- [ ] 需要更新环境变量 -- [ ] 需要更新 wrangler.toml -- [ ] 需要更新平台配置 - -### 部署风险 - -评估部署风险： - -- [ ] 低风险 - 仅文档或小幅改进 -- [ ] 中风险 - 功能增强或重构 -- [ ] 高风险 - 核心逻辑变更 - -### 回滚计划 - -如果需要回滚，说明回滚步骤： - -## 📊 性能影响 - -### 性能指标 - -如果涉及性能变更，请提供相关数据： - -#### 响应时间 - -- 变更前： -- 变更后： -- 改进幅度： - -#### 内存使用 - -- 变更前： -- 变更后： -- 变化情况： - -#### 缓存效率 - -- 缓存命中率变化： -- 缓存策略优化： - -## 🔒 安全考虑 - -### 安全影响 - -- [ ] 此变更不涉及安全问题 -- [ ] 此变更增强了安全性 -- [ ] 此变更可能有安全影响（请详细说明） - -### 安全检查 - -- [ ] 输入验证充分 -- [ ] 输出编码正确 -- [ ] 权限控制适当 -- [ ] 敏感信息保护 - -## 📸 截图/演示 - -如果适用，请提供截图或演示 URL： - -## 💬 其他说明 - -### 已知问题 - -列出任何已知的问题或限制： - -### 后续工作 - -描述可能的后续改进或相关工作： - -### 特别说明 - -任何需要审查者特别注意的地方： - ---- - -## 审查者检查清单 - -### 代码审查 - -- [ ] 代码逻辑正确 -- [ ] 代码风格一致 -- [ ] 性能考虑充分 -- [ ] 安全措施到位 - -### 功能验证 - -- [ ] 功能按预期工作 -- [ ] 边界情况处理正确 -- [ ] 错误处理完善 - -### 文档检查 - -- [ ] 文档更新完整 -- [ ] 示例代码正确 -- [ ] 配置说明清晰 - -### 测试验证 - -- [ ] 测试用例充分 -- [ ] 测试结果可信 -- [ ] 覆盖率满足要求 - ---- - -感谢您的贡献！🎉 + diff --git a/scripts/README.md b/scripts/README.md deleted file mode 100644 index 81e4dbd..0000000 --- a/scripts/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# 脚本 - -此目录包含存储库的维护与开发工具。 - -## 可用脚本 - -### fix-badge-colors.js - -用于 README 文件的徽章颜色校验与自动修复工具。 - -**用途：** 确保 README.md 与 README.en.md 中的所有徽章颜色与 Simple Icons 官方品牌颜色一致。 - -**用法：** - -```bash -# 校验徽章颜色（只读） -node scripts/fix-badge-colors.js - -# 校验并自动修复不匹配项 -node scripts/fix-badge-colors.js --fix -``` - -**功能：** - -- 从 Simple Icons 官方仓库获取最新颜色 -- 扫描 README.md 与 README.en.md -- 识别颜色不匹配项 -- 在提供 `--fix` 标志时自动修复不匹配项 -- 生成包含修复前后颜色值的详细报告 - -**适用场景：** - -- 在提交新增/修改徽章的 PR 之前 -- 例行维护以确保品牌一致性 -- Simple Icons 更新品牌颜色后 - ---- - -有关存储库的更多信息，请参阅主 [README](../README.md)。