chore: align repository docs and ci
This commit is contained in:
1 parent
c9a36e8e0a
commit
82c27dab5e
30 files changed
+392
-1444
No files matched your search
@@ -1,167 +1,67 @@
|
||||
name: 🐛 bug 报告
|
||||
description: 报告一个问题或错误
|
||||
name: Bug report
|
||||
description: Report a reproducible problem in Xget
|
||||
title: "[Bug]: "
|
||||
labels: ["bug", "需要分类"]
|
||||
assignees: []
|
||||
|
||||
labels:
|
||||
- bug
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢你花时间填写这个 bug 报告!请尽可能详细地描述问题,这将帮助我们更快地定位和修复问题。
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: 前置检查
|
||||
description: 在提交 Issue 之前,请确认以下事项
|
||||
options:
|
||||
- label: 我已经搜索过现有的 Issues,确认这不是重复问题
|
||||
required: true
|
||||
- label: 我已经查看过文档和 README
|
||||
required: true
|
||||
- label: 我已经确认当前部署配置与文档一致
|
||||
required: false
|
||||
Thanks for taking the time to report a bug.
|
||||
|
||||
Please search existing issues before filing a new one. If this is a security
|
||||
vulnerability, do not continue here. Follow the private reporting instructions
|
||||
in [SECURITY.md](https://github.com/xixu-me/Xget/blob/main/SECURITY.md).
|
||||
- type: textarea
|
||||
id: description
|
||||
id: summary
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 清晰简洁地描述遇到的问题
|
||||
placeholder: 描述你遇到了什么问题...
|
||||
label: What happened?
|
||||
description: Describe the problem and the actual behavior you observed.
|
||||
placeholder: A request to /npm/... returns the wrong upstream path when...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: 重现步骤
|
||||
description: 提供重现问题的详细步骤
|
||||
placeholder: |
|
||||
1. 访问 '...'
|
||||
2. 执行命令 '...'
|
||||
3. 观察到错误 '...'
|
||||
value: |
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 期望行为
|
||||
description: 描述你期望发生什么
|
||||
placeholder: 应该...
|
||||
label: What did you expect to happen?
|
||||
placeholder: The request should be rewritten to...
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Which area is affected?
|
||||
options:
|
||||
- Routing or path transformation
|
||||
- Git protocol
|
||||
- Docker or OCI registry support
|
||||
- AI inference proxying
|
||||
- Cache behavior
|
||||
- Security headers or validation
|
||||
- Deployment or adapter behavior
|
||||
- Documentation
|
||||
- Something else
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: 实际行为
|
||||
description: 描述实际发生了什么
|
||||
placeholder: 但实际上...
|
||||
label: Steps to reproduce
|
||||
description: Share a minimal reproduction with secrets removed.
|
||||
placeholder: |
|
||||
1. Send request to...
|
||||
2. Use headers...
|
||||
3. Observe...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: platform
|
||||
attributes:
|
||||
label: 受影响的平台
|
||||
description: 选择问题相关的平台(可多选)
|
||||
multiple: true
|
||||
options:
|
||||
- GitHub
|
||||
- GitLab
|
||||
- npm
|
||||
- PyPI
|
||||
- Docker Hub
|
||||
- crates.io
|
||||
- Maven Central
|
||||
- Homebrew
|
||||
- Jenkins
|
||||
- OpenAI API
|
||||
- Anthropic API
|
||||
- 其他 AI 推理 API
|
||||
- 不确定/不适用
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: request_type
|
||||
attributes:
|
||||
label: 请求类型
|
||||
description: 选择问题相关的请求类型
|
||||
options:
|
||||
- Git 克隆/拉取
|
||||
- Git LFS
|
||||
- Docker 镜像拉取
|
||||
- 包下载 (npm/PyPI/Maven 等)
|
||||
- AI API 推理请求
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
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: |
|
||||
粘贴错误日志...
|
||||
|
||||
- type: textarea
|
||||
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"
|
||||
|
||||
label: Environment
|
||||
description: Include runtime, deployment target, client, and version details when relevant.
|
||||
placeholder: Cloudflare Workers, local wrangler dev, curl 8.8.0, Node.js 24...
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: 附加信息
|
||||
description: |
|
||||
提供任何其他有助于理解问题的上下文、截图或信息
|
||||
提示: 你可以拖拽图片到这里上传
|
||||
|
||||
- type: dropdown
|
||||
id: severity
|
||||
attributes:
|
||||
label: 严重程度
|
||||
description: 这个问题对你的影响有多大?
|
||||
options:
|
||||
- 严重 - 核心功能完全无法使用
|
||||
- 高 - 重要功能受阻
|
||||
- 中 - 功能可用但有明显问题
|
||||
- 低 - 轻微问题或不便
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: contribution
|
||||
attributes:
|
||||
label: 贡献意愿
|
||||
description: 你是否愿意提交 PR 来修复这个问题?
|
||||
options:
|
||||
- label: 我愿意提交 PR 来修复这个问题
|
||||
label: Additional context
|
||||
description: Logs, headers, screenshots, or links that help explain the issue.
|
||||
@@ -1,11 +1,14 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- 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/security/policy#-%E6%8A%A5%E5%91%8A%E5%AE%89%E5%85%A8%E6%BC%8F%E6%B4%9E
|
||||
about: 报告安全漏洞
|
||||
- name: Read the README
|
||||
url: https://github.com/xixu-me/Xget/blob/main/README.md
|
||||
about: Check supported platforms, usage examples, and deployment options first.
|
||||
- name: Contributing Guide
|
||||
url: https://github.com/xixu-me/Xget/blob/main/CONTRIBUTING.md
|
||||
about: Learn how to prepare a bug report or pull request.
|
||||
- name: Security Policy
|
||||
url: https://github.com/xixu-me/Xget/blob/main/SECURITY.md
|
||||
about: Use this for private vulnerability reporting instructions.
|
||||
- name: Maintainer contact page
|
||||
url: https://xi-xu.me/#contact
|
||||
about: Use a private contact path for sensitive or non-public matters.
|
||||
@@ -1,172 +0,0 @@
|
||||
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: 提供任何其他有助于改进文档的信息或建议
|
||||
@@ -1,167 +1,46 @@
|
||||
name: ✨ 功能请求
|
||||
description: 建议一个新功能或改进
|
||||
name: Feature request
|
||||
description: Propose an improvement or new capability for Xget
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement", "需要分类"]
|
||||
assignees: []
|
||||
|
||||
labels:
|
||||
- enhancement
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢你提出新功能建议!请详细描述你的想法,这将帮助我们更好地评估和实现。
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: 前置检查
|
||||
description: 在提交功能请求之前,请确认以下事项
|
||||
options:
|
||||
- label: 我已经搜索过现有的 Issues 和 PR,确认这不是重复请求
|
||||
required: true
|
||||
- label: 我已经查看过存储库文档
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: feature_type
|
||||
attributes:
|
||||
label: 功能类型
|
||||
description: 这个请求属于什么类型?
|
||||
options:
|
||||
- 新协议支持
|
||||
- 性能优化
|
||||
- 缓存改进
|
||||
- 安全增强
|
||||
- 监控/日志功能
|
||||
- 配置选项
|
||||
- API 改进
|
||||
- 文档改进
|
||||
- 开发体验改进
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
Thanks for sharing an idea.
|
||||
|
||||
Please keep requests focused and explain the user or maintainer value clearly.
|
||||
For large changes, starting with an issue before implementation is strongly preferred.
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: 问题背景
|
||||
description: 描述你想解决的问题或痛点
|
||||
placeholder: |
|
||||
我在使用 Xget 时遇到了...
|
||||
当前的方式是...,但是...
|
||||
label: What problem are you trying to solve?
|
||||
description: Describe the user need, operational pain point, or workflow gap.
|
||||
placeholder: Users of platform X cannot...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
id: proposal
|
||||
attributes:
|
||||
label: 建议的解决方案
|
||||
description: 清晰地描述你希望实现的功能
|
||||
placeholder: 我希望 Xget 能够...
|
||||
label: What change would you like to see?
|
||||
description: Describe the proposed behavior or feature.
|
||||
placeholder: Add support for...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: 备选方案
|
||||
description: 描述你考虑过的其他替代解决方案
|
||||
placeholder: |
|
||||
我也考虑过...
|
||||
但这个方案的问题是...
|
||||
|
||||
label: Alternatives considered
|
||||
description: Describe any workarounds or alternative approaches you evaluated.
|
||||
- type: textarea
|
||||
id: use_case
|
||||
attributes:
|
||||
label: 使用场景
|
||||
description: 描述具体的使用场景和预期效果
|
||||
placeholder: |
|
||||
场景 1: 当用户...时,这个功能可以...
|
||||
场景 2: 在...情况下,能够...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: 优先级
|
||||
description: 这个功能对你有多重要?
|
||||
options:
|
||||
- 高 - 对我的工作流程至关重要
|
||||
- 中 - 会显著改善使用体验
|
||||
- 低 - 有更好,但不是必需的
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: platform_specific
|
||||
attributes:
|
||||
label: 特定平台需求
|
||||
description: 如果这是平台相关的功能请求,请提供详细信息
|
||||
placeholder: |
|
||||
- 平台名称:
|
||||
- 平台 URL:
|
||||
- API 文档:
|
||||
- 认证方式:
|
||||
- 特殊要求:
|
||||
|
||||
- type: textarea
|
||||
id: technical_details
|
||||
attributes:
|
||||
label: 技术细节
|
||||
description: 如果你有技术实现建议,请在此描述
|
||||
placeholder: |
|
||||
实现方式可能包括:
|
||||
1. 在 platforms.js 中添加...
|
||||
2. 需要处理...协议
|
||||
3. 可能的挑战是...
|
||||
|
||||
- type: textarea
|
||||
id: examples
|
||||
attributes:
|
||||
label: 示例和参考
|
||||
description: 提供相关的示例、链接或参考实现
|
||||
placeholder: |
|
||||
- 类似实现:
|
||||
- 官方文档:
|
||||
- 示例请求:
|
||||
|
||||
- type: checkboxes
|
||||
id: impact
|
||||
attributes:
|
||||
label: 影响范围
|
||||
description: 这个功能可能影响哪些方面?(可多选)
|
||||
options:
|
||||
- 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: 我可以帮助编写文档
|
||||
|
||||
label: Why is this valuable?
|
||||
description: Explain who benefits and why the change fits Xget's goals.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: 附加信息
|
||||
description: 提供任何其他有助于理解这个功能请求的信息
|
||||
label: Additional context
|
||||
description: Add links, examples, or prior art if helpful.
|
||||
@@ -1,236 +0,0 @@
|
||||
name: ⚡ 性能问题
|
||||
description: 报告性能相关的问题或建议性能优化
|
||||
title: "[Performance]: "
|
||||
labels: ["performance", "需要分类"]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢你报告性能问题!请提供详细的性能指标和场景,这将帮助我们诊断和优化。
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: 前置检查
|
||||
options:
|
||||
- label: 我已经搜索过现有的性能相关 Issues
|
||||
required: true
|
||||
- label: 我已经确认这不是上游平台本身的性能问题
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: issue_type
|
||||
attributes:
|
||||
label: 问题类型
|
||||
description: 选择性能问题的类型
|
||||
options:
|
||||
- 响应时间过长
|
||||
- 超时错误
|
||||
- 高延迟
|
||||
- 带宽限制
|
||||
- 缓存未命中
|
||||
- 内存使用过高
|
||||
- 并发性能问题
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: affected_platform
|
||||
attributes:
|
||||
label: 受影响的平台
|
||||
description: 哪个平台的性能出现问题?
|
||||
options:
|
||||
- GitHub
|
||||
- GitLab
|
||||
- npm
|
||||
- PyPI
|
||||
- Docker Hub
|
||||
- crates.io
|
||||
- Maven Central
|
||||
- Homebrew
|
||||
- Jenkins
|
||||
- OpenAI API
|
||||
- Anthropic API
|
||||
- 多个平台
|
||||
- 所有平台
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: operation_type
|
||||
attributes:
|
||||
label: 操作类型
|
||||
description: 什么类型的操作性能有问题?
|
||||
options:
|
||||
- Git 克隆
|
||||
- Git 拉取
|
||||
- Git LFS 下载
|
||||
- Docker 镜像拉取
|
||||
- 包下载
|
||||
- AI API 请求
|
||||
- 元数据获取
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 详细描述性能问题
|
||||
placeholder: |
|
||||
在执行...操作时,性能明显低于预期...
|
||||
相比直接访问上游,速度慢了...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: metrics
|
||||
attributes:
|
||||
label: 性能指标
|
||||
description: 提供具体的性能数据
|
||||
placeholder: |
|
||||
- 响应时间: XX ms (预期 < YY ms)
|
||||
- 下载速度: XX KB/s (上游直连: YY KB/s)
|
||||
- 首字节时间 (TTFB): XX ms
|
||||
- 总耗时: XX 秒
|
||||
- X-Performance-Metrics 头信息: {...}
|
||||
render: markdown
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
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: 提供任何其他有助于诊断性能问题的信息
|
||||
@@ -1,233 +0,0 @@
|
||||
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: 提供任何其他有助于实现这个平台支持的信息
|
||||
@@ -1,106 +1,23 @@
|
||||
## 概述
|
||||
## Summary
|
||||
|
||||
<!-- 请简要描述此 PR 的目的和改动内容 -->
|
||||
- What does this change do?
|
||||
- Why is it needed?
|
||||
|
||||
## 改动类型
|
||||
## Testing
|
||||
|
||||
<!-- 请勾选适用的改动类型 -->
|
||||
|
||||
- [ ] 🐛 bug 修复
|
||||
- [ ] ✨ 新功能
|
||||
- [ ] 📝 文档更新
|
||||
- [ ] 🎨 代码风格/格式调整
|
||||
- [ ] ♻️ 代码重构
|
||||
- [ ] ⚡️ 性能优化
|
||||
- [ ] ✅ 测试相关
|
||||
- [ ] 🔧 配置文件修改
|
||||
- [ ] 🌐 新增平台支持
|
||||
- [ ] 🔒 安全相关
|
||||
|
||||
## 相关 Issue
|
||||
|
||||
<!-- 如果此 PR 解决了某个 Issue,请在此关联 -->
|
||||
|
||||
Closes #
|
||||
Related to #
|
||||
|
||||
## 改动说明
|
||||
|
||||
<!-- 详细描述你做了什么改动,以及为什么这样做 -->
|
||||
|
||||
### 主要改动
|
||||
|
||||
-
|
||||
|
||||
### 技术细节
|
||||
|
||||
-
|
||||
|
||||
## 测试
|
||||
|
||||
<!-- 描述你如何测试了这些改动 -->
|
||||
|
||||
- [ ] 已通过所有现有测试 (`npm run test:run`)
|
||||
- [ ] 已添加新的测试用例
|
||||
- [ ] 已在本地开发环境测试 (`npm run dev`)
|
||||
- [ ] 已验证代码格式 (`npm run format:check`)
|
||||
- [ ] 已通过类型检查 (`npm run type-check`)
|
||||
- [ ] 已通过 lint 检查 (`npm run lint`)
|
||||
|
||||
### 测试环境
|
||||
|
||||
<!-- 描述测试的环境和场景 -->
|
||||
|
||||
-
|
||||
|
||||
## 影响范围
|
||||
|
||||
<!-- 此改动会影响哪些部分? -->
|
||||
|
||||
- [ ] 核心请求处理逻辑
|
||||
- [ ] 平台配置
|
||||
- [ ] 协议处理 (Git/Docker/AI)
|
||||
- [ ] 缓存策略
|
||||
- [ ] 安全功能
|
||||
- [ ] 性能监控
|
||||
- [ ] 文档
|
||||
- [ ] CI/CD 流程
|
||||
|
||||
## 破坏性变更
|
||||
|
||||
<!-- 此 PR 是否包含破坏性变更?如果是,请详细说明 -->
|
||||
|
||||
- [ ] 是
|
||||
- [ ] 否
|
||||
|
||||
<details>
|
||||
<summary>破坏性变更详情</summary>
|
||||
|
||||
<!-- 如果有破坏性变更,请在此详细说明 -->
|
||||
|
||||
</details>
|
||||
|
||||
## 部署说明
|
||||
|
||||
<!-- 部署此改动时需要注意什么?是否需要环境变量配置? -->
|
||||
|
||||
-
|
||||
|
||||
## 截图/演示
|
||||
|
||||
<!-- 如果适用,请提供截图或演示 -->
|
||||
- [ ] `npm run lint`
|
||||
- [ ] `npm run format:check`
|
||||
- [ ] `npm run test:run`
|
||||
- [ ] `npm run type-check`
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] 代码遵循存储库的编码规范
|
||||
- [ ] 已进行自我代码审查
|
||||
- [ ] 代码注释清晰,特别是复杂逻辑部分
|
||||
- [ ] 已更新相关文档
|
||||
- [ ] 改动不会产生新的警告
|
||||
- [ ] 已添加必要的测试,且测试通过
|
||||
- [ ] 新增和现有的单元测试都通过
|
||||
- [ ] 依赖的改动已合并并发布
|
||||
- [ ] I kept the change focused and avoided unrelated edits
|
||||
- [ ] I added or updated tests when behavior changed
|
||||
- [ ] I updated documentation when user-facing behavior changed
|
||||
- [ ] I removed or redacted secrets, tokens, and private data from examples
|
||||
|
||||
## 附加说明
|
||||
## Notes for reviewers
|
||||
|
||||
<!-- 其他需要审查者知道的信息 -->
|
||||
- Related issue:
|
||||
- Risk or rollout notes:
|
||||
Reference in new issue
Block a user