1
0
forked from boos/BoosAPI

feat: update issue templates for bug reports, documentation updates, feature requests, and questions with improved clarity and bilingual support

This commit is contained in:
ciat-777
2026-03-15 14:00:23 +08:00
parent 8cd81ff48d
commit 916b9d6d73
4 changed files with 244 additions and 75 deletions
+116 -34
View File
@@ -1,80 +1,162 @@
name: Bug report name: Bug Report / Bug 反馈
description: Report a reproducible problem in Metapi description: Report a bug to help us improve / 报告 bug 帮助我们改进
title: "[Bug]: " title: "[Bug]: "
labels: ["bug"] labels: ["bug"]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for reporting a bug. Please include enough detail for someone else to reproduce it. Thanks for taking the time to fill out this bug report. Even a brief description helps us understand what went wrong. If you can share the details below, it usually helps us reproduce the issue without asking you to repeat yourself.
感谢您愿意告诉我们这个问题。哪怕只是简要描述,也能帮助我们理解发生了什么。如果方便的话,补充下面这些信息,通常能帮助我们更快复现问题,也尽量减少反复向您确认。
- type: checkboxes - type: checkboxes
id: checks id: pre-submission
attributes: attributes:
label: Before submitting label: Pre-submission Checklist / 提交前检查清单
description: Please confirm the following before submitting / 提交前请确认以下内容
options: options:
- label: I searched existing issues to avoid creating a duplicate - label: I searched existing issues to avoid creating a duplicate / 我已检索现有 issue,确认这不是重复问题
required: true required: true
- label: I tested on the latest release or current main branch - label: I tested on the latest release or current main branch / 我已在最新 release 或 main 分支版本中复现
required: true required: true
- type: dropdown - type: dropdown
id: deployment id: deployment
attributes: attributes:
label: Deployment type label: Deployment Type / 部署方式
description: Where did you reproduce the problem? description: Where did you reproduce the problem? / 您是在什么运行方式下复现这个问题的?
options: options:
- Web app - Docker Compose / Docker Compose 部署
- Desktop app - Docker run / Docker 命令部署
- Server only - Desktop app / 桌面端
- Docker deployment - Local development / 本地源码开发
- Other - Zeabur deployment / Zeabur 部署
- Render deployment / Render 部署
- Other / 其他
validations: validations:
required: true required: true
- type: textarea - type: dropdown
id: summary id: problem-area
attributes: attributes:
label: What happened? label: Problem Area / 问题模块
description: Describe the bug clearly and concisely. description: Which part of Metapi seems related? Optional, but helpful. / 您觉得问题和 Metapi 的哪个模块有关?选填,但有助于排查。
placeholder: Describe the problem you observed. options:
- Site / Account Management / 站点与账号管理
- Token Management / 令牌管理
- Routing / 路由
- Proxy API (/v1/*) / 代理接口
- Model Marketplace / 模型广场
- Check-in / 签到
- Notifications / 通知
- Desktop App / 桌面端
- Deployment / Database / 部署或数据库
- Other / 其他
validations: validations:
required: true required: false
- type: textarea - type: textarea
id: reproduce id: app-version
attributes: attributes:
label: Steps to reproduce label: Metapi Version / Metapi 版本
description: Tell us the version, image tag, or commit if you know it. / 如果您知道,请填写版本号、镜像标签或 commit。
placeholder: | placeholder: |
1. Go to ... e.g. v1.2.2 / latest / commit SHA
2. Configure ... 例如 v1.2.2 / latest / commit SHA
3. Send request ... validations:
4. Observe ... required: true
- type: dropdown
id: database
attributes:
label: Database Type / 数据库类型
description: Which runtime database are you using? / 您当前运行时使用的是哪种数据库?
options:
- SQLite
- MySQL
- PostgreSQL
- Not sure / 不确定
validations:
required: false
- type: textarea
id: bug-description
attributes:
label: Bug Description / Bug 描述
description: A clear and concise description of what the bug is / 清晰简洁地描述这个 bug 是什么
placeholder: |
Describe the problem you observed.
请描述您实际遇到的问题。
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: expected id: steps-to-reproduce
attributes: attributes:
label: Expected behavior label: Steps To Reproduce / 复现步骤
placeholder: Describe what you expected to happen. description: Steps to reproduce the behavior / 请尽量提供稳定复现的步骤
placeholder: |
1. Go to ... / 打开 ...
2. Configure ... / 配置 ...
3. Click or send request ... / 点击或发送请求 ...
4. Observe the result ... / 观察结果 ...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior / 预期行为
description: What did you expect to happen? / 您原本期望发生什么?
placeholder: |
Describe the expected behavior.
请描述您期望的正确行为。
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior / 实际行为
description: What actually happened? / 实际发生了什么?
placeholder: |
Describe the actual result.
请描述实际发生的结果。
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
label: Logs, screenshots, or error output label: Logs Or Error Output / 日志或错误输出
description: Paste logs or attach screenshots if available. description: Paste relevant logs, stack traces, request/response snippets, or screenshots of error output. / 请粘贴相关日志、报错堆栈、请求/响应片段,或错误输出截图。
render: shell render: shell
- type: textarea
id: screenshots
attributes:
label: Screenshots / 截图
description: If applicable, add screenshots to help explain the problem. / 如果方便,请附上截图帮助说明问题。
- type: textarea - type: textarea
id: environment id: environment
attributes: attributes:
label: Environment label: Environment Details / 环境信息
description: Include OS, browser, app version, database type, or other relevant details. description: Include OS, host platform, reverse proxy, client tool, browser version if relevant, and anything else that might matter. / 请补充系统、宿主环境、反向代理、客户端工具,以及在相关时补充浏览器版本等信息。
placeholder: | placeholder: |
OS: OS:
Browser: Deployment:
Host platform:
Reverse proxy:
Client tool:
Metapi version: Metapi version:
Database: Database:
操作系统:
部署方式:
宿主环境:
反向代理:
客户端工具:
Metapi 版本:
数据库:
+37 -12
View File
@@ -1,40 +1,65 @@
name: Documentation update name: Documentation Update / 文档反馈
description: Report missing, incorrect, or unclear documentation description: Report missing, incorrect, or unclear documentation / 反馈文档缺失、错误或不清晰的问题
title: "[Docs]: " title: "[Docs]: "
labels: ["docs"] labels: ["docs"]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Use this template when documentation is missing, incorrect, or hard to follow. Use this template when documentation is missing, incorrect, outdated, or hard to follow.
如果文档存在缺失、错误、过时或难以理解的问题,请使用这个模板。
- type: checkboxes - type: checkboxes
id: checks id: checks
attributes: attributes:
label: Before submitting label: Before submitting / 提交前确认
options: options:
- label: I searched existing issues to avoid creating a duplicate - label: I searched existing issues to avoid creating a duplicate / 我已搜索现有 issue,确认这不是重复反馈
required: true required: true
- type: input - type: input
id: location id: location
attributes: attributes:
label: Documentation location label: Documentation Location / 文档位置
description: Link the page or file that needs attention. description: Link the page or file that needs attention. / 请填写需要修改的页面、章节或文件路径。
placeholder: e.g. README.md or docs/getting-started.md placeholder: e.g. README.md or docs/getting-started.md / 例如 README.md 或 docs/getting-started.md
validations: validations:
required: true required: true
- type: dropdown
id: doc-area
attributes:
label: Documentation Area / 文档类型
description: Which documentation area is affected? / 受影响的是哪一类文档?
options:
- README / 项目首页说明
- Getting Started / 快速开始
- Deployment / 部署
- Configuration / 配置
- Client Integration / 客户端接入
- FAQ / 常见问题
- Operations / 运维
- Other / 其他
validations:
required: false
- type: textarea - type: textarea
id: issue id: issue
attributes: attributes:
label: What is wrong or missing? label: What Is Wrong Or Missing? / 哪里有问题或缺失?
placeholder: Describe the missing, inaccurate, or confusing part. description: Describe the missing, inaccurate, outdated, or confusing part. / 请描述缺失、不准确、过时或不清晰的内容。
placeholder: |
Describe the missing, inaccurate, or confusing part.
请说明哪一部分有问题,以及为什么会造成困惑。
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: fix id: fix
attributes: attributes:
label: Suggested improvement label: Suggested Improvement / 建议修改方式
placeholder: Describe how the documentation could be improved. description: Describe how the documentation could be improved. / 请描述您建议的修改方式或理想写法。
placeholder: |
Describe how the documentation could be improved.
请尽量给出建议内容、结构或示例。
+46 -17
View File
@@ -1,49 +1,78 @@
name: Feature request name: Feature Request / 功能请求
description: Suggest a new capability or improvement description: Suggest a new feature or enhancement / 建议新功能或改进
title: "[Feature]: " title: "[Feature]: "
labels: ["enhancement"] labels: ["enhancement"]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for the suggestion. Keep this issue focused on one feature request. Thanks for taking the time to suggest a new feature. A focused request with enough context helps us evaluate the idea much faster.
感谢您提出功能建议。一个聚焦、信息完整的功能请求,通常能让我们更快判断需求价值和实现方向。
- type: checkboxes - type: checkboxes
id: checks id: pre-submission
attributes: attributes:
label: Before submitting label: Pre-submission Checklist / 提交前检查清单
description: Please confirm the following before submitting / 提交前请确认以下内容
options: options:
- label: I searched existing issues to avoid creating a duplicate - label: I searched existing issues to avoid creating a duplicate / 我已检索现有 issue,确认这不是重复需求
required: true required: true
- label: I confirmed this feature is not already available in the latest release or main branch - label: I confirmed this feature is not already available in the latest release or main branch / 我已确认该功能尚未在最新 release 或 main 分支中提供
required: true required: true
- type: textarea - type: textarea
id: problem id: problem
attributes: attributes:
label: Problem or use case label: Problem Or Use Case / 使用场景或问题背景
description: What problem are you trying to solve? description: What problem are you trying to solve? What is inconvenient today? / 您想解决什么问题?当前使用上哪里不方便?
placeholder: Explain the workflow or pain point behind this request. placeholder: |
Explain the workflow or pain point behind this request.
请描述当前流程、痛点或为什么需要这个功能。
validations: validations:
required: true required: true
- type: dropdown
id: area
attributes:
label: Related Area / 相关模块
description: Which part of Metapi is this feature mainly about? / 这个功能主要涉及 Metapi 的哪个模块?
options:
- Site / Account Management / 站点与账号管理
- Token Management / 令牌管理
- Routing / 路由
- Proxy API (/v1/*) / 代理接口
- Model Marketplace / 模型广场
- Check-in / 签到
- Notifications / 通知
- Desktop App / 桌面端
- Deployment / Database / 部署或数据库
- Other / 其他
validations:
required: false
- type: textarea - type: textarea
id: proposal id: proposal
attributes: attributes:
label: Proposed solution label: Proposed Solution / 建议的解决方案
description: Describe the change you want to see. description: Describe the change you want to see. / 请描述您希望增加的功能或行为变化。
placeholder: Explain the feature or behavior you want added. placeholder: |
Explain the feature or behavior you want added.
请尽量具体描述您希望如何实现。
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: alternatives id: alternatives
attributes: attributes:
label: Alternatives considered label: Alternatives Considered / 考虑过的替代方案
description: Describe any workaround or alternative you considered. description: Describe any workaround or alternative approach you considered. / 请描述您考虑过的替代方案、当前 workaround,或为什么现有方式不够好。
- type: textarea - type: textarea
id: context id: context
attributes: attributes:
label: Additional context label: Additional Context / 其他信息
description: Add screenshots, examples, or links if they help explain the request. description: Add screenshots, examples, related issues, or links if they help explain the request. / 如果截图、示例、关联 issue 或参考链接有帮助,请补充在这里。
placeholder: |
You can include route examples, API paths, screenshots, upstream platform names, or migration concerns.
可以补充路由示例、API 路径、截图、上游平台名称,或兼容性/迁移方面的考虑。
+45 -12
View File
@@ -1,39 +1,72 @@
name: Question name: Question / 使用问题
description: Ask for clarification or usage guidance description: Ask for clarification or usage guidance / 询问使用方法、配置方式或行为解释
title: "[Question]: " title: "[Question]: "
labels: ["question"] labels: ["question"]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Use this template for support or clarification questions that are not bug reports or feature requests. Use this template for support or clarification questions that are not bug reports or feature requests. The more context you share, the easier it is for us to give a direct answer.
如果这是使用方式、配置方法或行为解释相关的问题,请使用这个模板。您提供的上下文越完整,我们越容易直接给出准确答案。
- type: checkboxes - type: checkboxes
id: checks id: checks
attributes: attributes:
label: Before submitting label: Before submitting / 提交前确认
options: options:
- label: I searched existing issues and the README for an answer - label: I searched existing issues and the README for an answer / 我已搜索现有 issue 和 README,但还没有找到答案
required: true required: true
- type: textarea - type: textarea
id: question id: question
attributes: attributes:
label: Question label: Question / 问题描述
description: What do you need help understanding? description: What do you need help understanding? / 您具体想确认什么问题?
placeholder: Ask one clear question and include the relevant context. placeholder: |
Ask one clear question and include the relevant context.
请尽量用一句话先说清楚您想问什么。
validations: validations:
required: true required: true
- type: dropdown
id: scenario
attributes:
label: Question Type / 问题类型
description: What kind of question is this? / 这是哪一类使用问题?
options:
- Deployment / 部署
- Configuration / 配置
- Client Integration / 客户端接入
- Routing / 路由
- Site / Account / Token / 站点、账号或令牌
- Desktop App / 桌面端
- Proxy API (/v1/*) / 代理接口
- Other / 其他
validations:
required: false
- type: textarea - type: textarea
id: tried id: tried
attributes: attributes:
label: What have you tried? label: What Have You Tried? / 您已经尝试过什么?
description: Include commands, config, or investigation you already attempted. description: Include commands, config, screenshots, or investigation you already attempted. / 请补充您已经尝试过的命令、配置、截图或排查过程。
- type: textarea - type: textarea
id: environment id: environment
attributes: attributes:
label: Relevant environment or config label: Relevant Environment Or Config / 相关环境或配置
description: Paste config snippets, request examples, or environment details if needed. description: Paste config snippets, request examples, deployment details, or environment information if needed. / 如有需要,请补充配置片段、请求示例、部署方式或环境信息。
placeholder: |
Deployment:
Base URL:
Client:
Database:
Related config:
部署方式:
Base URL:
客户端:
数据库:
相关配置:
render: shell render: shell