Skip to content

Commit 058fa1c

Browse files
james-6-23james-6-23
committed
chore(issues): add structured issue templates for bug/idea/ui/deploy/question
Five Chinese templates plus English bug/idea, with a config.yml that disables blank issues and routes security reports to GitHub Security Advisory.
1 parent ff2f029 commit 058fa1c

8 files changed

Lines changed: 287 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/01_bug_zh.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: 遇到问题 / 报错
2+
description: 网关报错、调度异常、统计不准、UI 卡住、Docker 起不来……都从这里提
3+
title: "[Bug] "
4+
labels: ["type/bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢反馈。贴日志或配置时，请把 **Refresh Token / Access Token / API Key / Cookie** 打码再发。
10+
11+
- type: dropdown
12+
id: area
13+
attributes:
14+
label: 哪块出了问题？
15+
options:
16+
- 网关 API（/v1/chat/completions、/responses、/messages、Images）
17+
- 账号池 / 调度 / 健康度 / 冷却恢复
18+
- 用量统计 / 计费 / API Key
19+
- 管理后台 UI（React 控制台）
20+
- 部署 / Docker / 环境变量 / 数据库
21+
- 其他 / 不太确定
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: what-happened
27+
attributes:
28+
label: 出了什么状况？
29+
description: 大概描述一下现象就行，能附上报错信息或截图更好。
30+
placeholder: |
31+
例如：调用 /v1/chat/completions 时返回 502，后台日志里看到 "no available account"……
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: how-to-trigger
37+
attributes:
38+
label: 怎么触发的？（可选）
39+
description: 不用很严格，"大概这样操作就出现了"也可以。
40+
placeholder: |
41+
1. 用 Codex CLI 连上网关
42+
2. 连续发了几条消息
43+
3. 第 3 条开始 502
44+
45+
- type: textarea
46+
id: env
47+
attributes:
48+
label: 环境信息（可选，能填就填）
49+
value: |
50+
- 部署形态：PG+Redis / SQLite+Memory / 源码 / 其他
51+
- 版本或 commit：
52+
- 客户端：Codex CLI / Claude Code / OpenAI SDK / 其他
53+
- 浏览器（前端问题填）：
54+
55+
- type: textarea
56+
id: extra
57+
attributes:
58+
label: 补充信息（可选）
59+
description: 想到什么写什么，比如怀疑是哪里的问题、试过什么解决方法。

‎.github/ISSUE_TEMPLATE/02_idea_zh.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 想法 / 增强建议
2+
description: 新功能、优化建议、"如果能这样就更好了"——不需要写得很完整
3+
title: "[Idea] "
4+
labels: ["type/enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
随手记下来就行，哪怕只是个一句话的方向，也欢迎提。
10+
11+
- type: textarea
12+
id: idea
13+
attributes:
14+
label: 你的想法
15+
placeholder: |
16+
例如：希望调度器支持按地区/延迟分组；希望 Image Studio 支持批量任务；
17+
希望 API Key 可以设置请求频率上限……
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: why
23+
attributes:
24+
label: 想解决什么问题 / 用在什么场景？（可选）
25+
placeholder: 现在是怎么用的，哪里别扭，加上这个会变成什么样。
26+
27+
- type: dropdown
28+
id: priority
29+
attributes:
30+
label: 对你来说有多重要？（随手选）
31+
options:
32+
- 顺手提一下，有就更好
33+
- 挺需要的，会影响日常使用
34+
- 强烈想要，目前是个明显痛点
35+
validations:
36+
required: false

‎.github/ISSUE_TEMPLATE/03_ui_zh.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 管理后台体验反馈
2+
description: 控制台 UI / 交互 / 视觉相关问题——截图比文字更有说服力
3+
title: "[UI] "
4+
labels: ["type/ui", "area/frontend"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
前端问题强烈建议附上 **截图或录屏**，一图胜千言。
10+
11+
- type: textarea
12+
id: detail
13+
attributes:
14+
label: 你看到了什么 / 想优化什么？
15+
description: 哪个页面、哪个组件、什么场景下出现的。
16+
placeholder: |
17+
例如：账号列表页在窄屏下表格列被挤变形；
18+
图表的颜色对比度太低看不清；
19+
某个按钮的 hover 状态很奇怪……
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: page
25+
attributes:
26+
label: 涉及的页面（可选）
27+
placeholder: 如 /admin/accounts、/admin/usage、Image Studio……
28+
29+
- type: textarea
30+
id: env
31+
attributes:
32+
label: 浏览器 / 屏幕信息（可选）
33+
placeholder: 如 Chrome 130 / macOS / 1920×1080；或手机 Safari 等。

‎.github/ISSUE_TEMPLATE/04_deploy_zh.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: 部署 / 配置求助
2+
description: Docker 起不来、环境变量不知道怎么填、SQLite/PG 切换、deploy.sh 报错……
3+
title: "[Deploy] "
4+
labels: ["type/help", "area/deploy"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
贴 docker-compose / env 时记得把 **密码、Token、API Key** 打码。
10+
11+
- type: dropdown
12+
id: shape
13+
attributes:
14+
label: 你用的部署形态？
15+
options:
16+
- Docker Compose（PostgreSQL + Redis）
17+
- Docker Compose（SQLite + Memory）
18+
- 源码直接运行
19+
- deploy.sh 脚本
20+
- Render / 其他云平台
21+
- 其他
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: trouble
27+
attributes:
28+
label: 卡在哪一步 / 报了什么错？
29+
description: 尽量贴上启动日志的报错段落，比凭印象描述准。
30+
placeholder: |
31+
例如：执行 docker compose up 后，codex2api 容器一直重启，
32+
日志里反复出现 "failed to connect to redis"……
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: tried
38+
attributes:
39+
label: 试过什么解决办法？（可选）
40+
placeholder: 比如改过哪些环境变量、查过哪些文档。

‎.github/ISSUE_TEMPLATE/05_question_zh.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: 使用问题 / 提问
2+
description: 不确定算不算 bug、配置疑问、对接其他工具的方法、文档没看明白……
3+
title: "[Question] "
4+
labels: ["type/question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
提问前可以先翻一下 [README](https://github.com/james-6-23/codex2api) 和 `docs/` 目录，
10+
很多常见问题已经写过了。
11+
12+
- type: textarea
13+
id: question
14+
attributes:
15+
label: 你想问什么？
16+
placeholder: |
17+
例如：怎么让一个 API Key 只能调 /v1/messages？
18+
round_robin 和 remaining_quota 该怎么选？
19+
如何把已有账号池迁到新机器？
20+
validations:
21+
required: true

‎.github/ISSUE_TEMPLATE/06_bug_en.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug Report (English)
2+
description: Something broke — gateway error, scheduler issue, UI glitch, deploy failure, etc.
3+
title: "[Bug] "
4+
labels: ["type/bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting. Please redact **Refresh Tokens / Access Tokens / API keys / cookies** before pasting logs or configs.
10+
11+
- type: dropdown
12+
id: area
13+
attributes:
14+
label: Which area is affected?
15+
options:
16+
- Gateway API (/v1/chat/completions, /responses, /messages, Images)
17+
- Account pool / scheduler / health / cooldown
18+
- Usage tracking / billing / API keys
19+
- Admin dashboard UI (React)
20+
- Deploy / Docker / env / database
21+
- Other / not sure
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: what-happened
27+
attributes:
28+
label: What went wrong?
29+
description: A short description is fine. Logs or screenshots help a lot.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: how-to-trigger
35+
attributes:
36+
label: How to reproduce? (optional)
37+
description: Rough steps are fine — no need to be exact.
38+
39+
- type: textarea
40+
id: env
41+
attributes:
42+
label: Environment (optional, fill what you know)
43+
value: |
44+
- Deploy shape: PG+Redis / SQLite+Memory / source / other
45+
- Version or commit:
46+
- Client: Codex CLI / Claude Code / OpenAI SDK / other
47+
- Browser (for UI issues):
48+
49+
- type: textarea
50+
id: extra
51+
attributes:
52+
label: Anything else? (optional)

‎.github/ISSUE_TEMPLATE/07_idea_en.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Idea / Enhancement (English)
2+
description: A new feature, an improvement, or a "wouldn't it be nice if…" — keep it short.
3+
title: "[Idea] "
4+
labels: ["type/enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Even a one-liner is welcome. Don't worry about writing a full spec.
10+
11+
- type: textarea
12+
id: idea
13+
attributes:
14+
label: Your idea
15+
placeholder: |
16+
e.g. group accounts by region/latency in the scheduler;
17+
batch jobs in Image Studio; per-API-key rate limits…
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: why
23+
attributes:
24+
label: What problem does it solve? (optional)
25+
26+
- type: dropdown
27+
id: priority
28+
attributes:
29+
label: How important is it to you? (just a vibe check)
30+
options:
31+
- Nice to have
32+
- Would noticeably improve daily use
33+
- Real pain point right now
34+
validations:
35+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 使用交流 / 闲聊讨论
4+
url: https://linux.do
5+
about: 不是明确的 bug 或建议？先到社区聊聊，可能很快就有答案。
6+
- name: 安全漏洞私密披露
7+
url: https://github.com/james-6-23/codex2api/security/advisories/new
8+
about: 发现安全问题请走 GitHub Security Advisory，不要在公开 issue 中提交。
9+
- name: 先翻一下文档
10+
url: https://github.com/james-6-23/codex2api#documentation
11+
about: 部署、配置、API 用法在 README 和 docs/ 里大多能找到答案。

0 commit comments

Comments
 (0)