Skip to content

Commit 1ca1d67

Browse files
committed
chore(issues): polish templates with first-person voice, prechecks, severity, and EN parity
- rewrite all field labels in first-person ("我的"/"My") so the rendered form reads as the submitter speaking - add "before I submit" checkboxes (search, redaction, docs read) to bug/idea/ui/deploy/question - add severity dropdown to bug templates (blocker/major/minor/trivial) - backfill EN bug placeholders to match ZH; add EN versions of UI/deploy/question - renumber files so zh/en pairs are adjacent (01/02 bug, 03/04 idea, 05/06 ui, 07/08 deploy, 09/10 question)
1 parent 6f0c1bb commit 1ca1d67

12 files changed

Lines changed: 301 additions & 79 deletions

.github/ISSUE_TEMPLATE/01_bug_zh.yml

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,20 @@ body:
88
value: |
99
感谢反馈。贴日志或配置时,请把 **Refresh Token / Access Token / API Key / Cookie** 打码再发。
1010
11+
- type: checkboxes
12+
id: prechecks
13+
attributes:
14+
label: 提交前我已确认
15+
options:
16+
- label: 我搜过 [已有 issues](https://github.com/james-6-23/codex2api/issues?q=is%3Aissue),没找到一样的问题
17+
required: true
18+
- label: 我已经把日志/配置里的 Token、API Key、密码等敏感信息打码
19+
required: true
20+
1121
- type: dropdown
1222
id: area
1323
attributes:
14-
label: 哪块出了问题
24+
label: 我遇到的问题在哪块
1525
options:
1626
- 网关 API(/v1/chat/completions、/responses、/messages、Images)
1727
- 账号池 / 调度 / 健康度 / 冷却恢复
@@ -22,38 +32,50 @@ body:
2232
validations:
2333
required: true
2434

35+
- type: dropdown
36+
id: severity
37+
attributes:
38+
label: 严重程度
39+
options:
40+
- 阻塞 — 功能完全无法使用
41+
- 严重 — 影响主要功能,但有 workaround
42+
- 一般 — 偶尔触发或影响次要功能
43+
- 轻微 — 体验小瑕疵,不影响使用
44+
validations:
45+
required: true
46+
2547
- type: textarea
2648
id: what-happened
2749
attributes:
28-
label: 出了什么状况
50+
label: 我遇到了什么状况
2951
description: 大概描述一下现象就行,能附上报错信息或截图更好。
3052
placeholder: |
31-
例如:调用 /v1/chat/completions 时返回 502,后台日志里看到 "no available account"……
53+
例如:我在调用 /v1/chat/completions 时返回 502,后台日志里看到 "no available account"……
3254
validations:
3355
required: true
3456

3557
- type: textarea
3658
id: how-to-trigger
3759
attributes:
38-
label: 怎么触发的?(可选)
39-
description: 不用很严格,"大概这样操作就出现了"也可以。
60+
label: 我是怎么触发的?(可选)
61+
description: 不用很严格,"我大概这样操作就出现了"也可以。
4062
placeholder: |
41-
1. Codex CLI 连上网关
63+
1. 我用 Codex CLI 连上网关
4264
2. 连续发了几条消息
4365
3. 第 3 条开始 502
4466
4567
- type: textarea
4668
id: env
4769
attributes:
48-
label: 环境信息(可选,能填就填)
70+
label: 我的环境信息(可选,能填就填)
4971
value: |
50-
- 部署形态:PG+Redis / SQLite+Memory / 源码 / 其他
51-
- 版本或 commit:
52-
- 客户端:Codex CLI / Claude Code / OpenAI SDK / 其他
53-
- 浏览器(前端问题填):
72+
- 我的部署形态:PG+Redis / SQLite+Memory / 源码 / 其他
73+
- 我的版本或 commit:
74+
- 我用的客户端:Codex CLI / Claude Code / OpenAI SDK / 其他
75+
- 我的浏览器(前端问题填):
5476
5577
- type: textarea
5678
id: extra
5779
attributes:
58-
label: 补充信息(可选)
59-
description: 想到什么写什么,比如怀疑是哪里的问题、试过什么解决方法
80+
label: 我的补充信息(可选)
81+
description: 想到什么写什么,比如我怀疑是哪里的问题、我试过什么解决方法
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ body:
88
value: |
99
Thanks for reporting. Please redact **Refresh Tokens / Access Tokens / API keys / cookies** before pasting logs or configs.
1010
11+
- type: checkboxes
12+
id: prechecks
13+
attributes:
14+
label: Before I submit
15+
options:
16+
- label: I searched [existing issues](https://github.com/james-6-23/codex2api/issues?q=is%3Aissue) and didn't find a duplicate
17+
required: true
18+
- label: I redacted tokens, API keys, passwords, and other secrets from logs/configs
19+
required: true
20+
1121
- type: dropdown
1222
id: area
1323
attributes:
@@ -22,11 +32,25 @@ body:
2232
validations:
2333
required: true
2434

35+
- type: dropdown
36+
id: severity
37+
attributes:
38+
label: Severity
39+
options:
40+
- Blocker — feature is completely unusable
41+
- Major — core feature affected, but a workaround exists
42+
- Minor — happens occasionally or affects a secondary feature
43+
- Trivial — cosmetic / small UX glitch
44+
validations:
45+
required: true
46+
2547
- type: textarea
2648
id: what-happened
2749
attributes:
2850
label: What went wrong?
2951
description: A short description is fine. Logs or screenshots help a lot.
52+
placeholder: |
53+
e.g. Calling /v1/chat/completions returned 502, and the backend log shows "no available account"…
3054
validations:
3155
required: true
3256

@@ -35,6 +59,10 @@ body:
3559
attributes:
3660
label: How to reproduce? (optional)
3761
description: Rough steps are fine — no need to be exact.
62+
placeholder: |
63+
1. Connect to the gateway with Codex CLI
64+
2. Send a few messages in a row
65+
3. The 3rd one starts returning 502
3866
3967
- type: textarea
4068
id: env
@@ -50,3 +78,4 @@ body:
5078
id: extra
5179
attributes:
5280
label: Anything else? (optional)
81+
description: Free-form notes — your guess at the root cause, things you've tried, related issues, etc.
Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,18 @@ body:
88
value: |
99
随手记下来就行,哪怕只是个一句话的方向,也欢迎提。
1010
11+
- type: checkboxes
12+
id: prechecks
13+
attributes:
14+
label: 提交前我已确认
15+
options:
16+
- label: 我搜过 [已有 issues](https://github.com/james-6-23/codex2api/issues?q=is%3Aissue),没看到类似的想法
17+
required: true
18+
1119
- type: textarea
1220
id: idea
1321
attributes:
14-
label: 你的想法
22+
label: 我的想法
1523
placeholder: |
1624
例如:希望调度器支持按地区/延迟分组;希望 Image Studio 支持批量任务;
1725
希望 API Key 可以设置请求频率上限……
@@ -21,16 +29,16 @@ body:
2129
- type: textarea
2230
id: why
2331
attributes:
24-
label: 想解决什么问题 / 用在什么场景?(可选)
25-
placeholder: 现在是怎么用的,哪里别扭,加上这个会变成什么样。
32+
label: 我想解决什么问题 / 用在什么场景?(可选)
33+
placeholder: 我现在是怎么用的,哪里别扭,加上这个会变成什么样。
2634

2735
- type: dropdown
2836
id: priority
2937
attributes:
30-
label: 对你来说有多重要?(随手选)
38+
label: 对我来说有多重要?(随手选)
3139
options:
3240
- 顺手提一下,有就更好
33-
- 挺需要的,会影响日常使用
41+
- 挺需要的,会影响我的日常使用
3442
- 强烈想要,目前是个明显痛点
3543
validations:
3644
required: false

.github/ISSUE_TEMPLATE/03_ui_zh.yml

Lines changed: 0 additions & 33 deletions
This file was deleted.
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,18 @@ body:
88
value: |
99
Even a one-liner is welcome. Don't worry about writing a full spec.
1010
11+
- type: checkboxes
12+
id: prechecks
13+
attributes:
14+
label: Before I submit
15+
options:
16+
- label: I searched [existing issues](https://github.com/james-6-23/codex2api/issues?q=is%3Aissue) and didn't see a similar idea
17+
required: true
18+
1119
- type: textarea
1220
id: idea
1321
attributes:
14-
label: Your idea
22+
label: My idea
1523
placeholder: |
1624
e.g. group accounts by region/latency in the scheduler;
1725
batch jobs in Image Studio; per-API-key rate limits…
@@ -22,11 +30,12 @@ body:
2230
id: why
2331
attributes:
2432
label: What problem does it solve? (optional)
33+
placeholder: How I'm using it today, what's awkward, and what changes if this lands.
2534

2635
- type: dropdown
2736
id: priority
2837
attributes:
29-
label: How important is it to you? (just a vibe check)
38+
label: How important is it to me? (just a vibe check)
3039
options:
3140
- Nice to have
3241
- Would noticeably improve daily use

.github/ISSUE_TEMPLATE/05_question_zh.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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: checkboxes
12+
id: prechecks
13+
attributes:
14+
label: 提交前我已确认
15+
options:
16+
- label: 我搜过 [已有 issues](https://github.com/james-6-23/codex2api/issues?q=is%3Aissue),没找到一样的问题
17+
required: true
18+
- label: 我会在下方附上截图或录屏(直接把图片拖进描述框即可)
19+
required: true
20+
21+
- type: textarea
22+
id: detail
23+
attributes:
24+
label: 我看到了什么 / 想优化什么?
25+
description: 哪个页面、哪个组件、什么场景下我遇到的。
26+
placeholder: |
27+
例如:我在窄屏下看账号列表页,表格列被挤变形;
28+
我觉得图表的颜色对比度太低看不清;
29+
我发现某个按钮的 hover 状态很奇怪……
30+
validations:
31+
required: true
32+
33+
- type: input
34+
id: page
35+
attributes:
36+
label: 我遇到的页面(可选)
37+
placeholder: 如 /admin/accounts、/admin/usage、Image Studio……
38+
39+
- type: textarea
40+
id: env
41+
attributes:
42+
label: 我的浏览器 / 屏幕信息(可选)
43+
placeholder: 如 Chrome 130 / macOS / 1920×1080;或手机 Safari 等。
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Admin UI Feedback (English)
2+
description: Admin console UI / interaction / visual issues — a screenshot is worth a thousand words
3+
title: "[UI] "
4+
labels: ["type/ui", "area/frontend"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
For frontend issues, please attach a **screenshot or screen recording** — much faster than describing in words.
10+
11+
- type: checkboxes
12+
id: prechecks
13+
attributes:
14+
label: Before I submit
15+
options:
16+
- label: I searched [existing issues](https://github.com/james-6-23/codex2api/issues?q=is%3Aissue) and didn't find a duplicate
17+
required: true
18+
- label: I'll attach a screenshot or recording below (just drag the image into the description box)
19+
required: true
20+
21+
- type: textarea
22+
id: detail
23+
attributes:
24+
label: What did I see / what should be improved?
25+
description: Which page, which component, in what scenario.
26+
placeholder: |
27+
e.g. On a narrow screen, the columns of the accounts list table get squashed;
28+
the chart colors are too low-contrast to read;
29+
the hover state on a button looks broken…
30+
validations:
31+
required: true
32+
33+
- type: input
34+
id: page
35+
attributes:
36+
label: Page involved (optional)
37+
placeholder: e.g. /admin/accounts, /admin/usage, Image Studio…
38+
39+
- type: textarea
40+
id: env
41+
attributes:
42+
label: Browser / screen info (optional)
43+
placeholder: e.g. Chrome 130 / macOS / 1920×1080; or mobile Safari, etc.

0 commit comments

Comments
 (0)