Skip to content

Commit ef0de70

Browse files
committed
docs: README 加『欢迎批斗』小节 + 补 issue 模板,降低反馈门槛
1 parent 7c06eac commit ef0de70

5 files changed

Lines changed: 111 additions & 0 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: "🐛 Bug 报告 / Bug report"
2+
description: "踩到坑了?把现场告诉我,我来修。"
3+
title: "[Bug] "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢来“批斗”我 😄 填得越详细,我修得越快。
10+
- type: textarea
11+
id: what
12+
attributes:
13+
label: "你遇到了什么 / What happened"
14+
description: "现象描述,比如“点开就闪退”"
15+
placeholder: "简短描述你看到的问题"
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: repro
20+
attributes:
21+
label: "怎么复现 / Steps to reproduce"
22+
placeholder: |
23+
1. 打开 …
24+
2. 点击 …
25+
3. 看到 …
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: env
30+
attributes:
31+
label: "环境 / Environment"
32+
placeholder: "系统 / 版本 / 浏览器 / 手机型号 / Termux 版本 …"
33+
validations:
34+
required: false
35+
- type: dropdown
36+
id: severity
37+
attributes:
38+
label: "严重程度 / Severity"
39+
options:
40+
- "崩了,完全用不了 / Broken"
41+
- "能用但很难受 / Annoying"
42+
- "小毛病 / Minor"
43+
validations:
44+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: "💬 想聊 / 想赞助 / Just want to chat"
4+
url: "https://afdian.com/a/cloudharbor"
5+
about: "吐槽、赞助、或者只是打个招呼都行。"
6+
- name: "🔍 先搜搜有没有重复 / Search first"
7+
url: "https://github.com/codecloud-dev/moxwebgpu/issues"
8+
about: "提交前可以先看看有没有重复的 issue。"
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "💡 功能建议 / Feature request"
2+
description: "想要个什么能力?说出来我看看。"
3+
title: "[Feature] "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
好主意!说说你想要什么、为什么想要。
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: "想解决什么问题 / Problem"
14+
placeholder: "现在什么让你不方便?"
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: idea
19+
attributes:
20+
label: "你期望的样子 / Your idea"
21+
placeholder: "你希望它怎么做?"
22+
validations:
23+
required: false
24+
- type: dropdown
25+
id: priority
26+
attributes:
27+
label: "对你有多重要 / How important"
28+
options:
29+
- "没它不行 / Must-have"
30+
- "有就更好 / Nice-to-have"
31+
- "随便想想 / Just dreaming"
32+
validations:
33+
required: false

‎README.en.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@
2424

2525
<p align="center">
2626
<b>⭐ If moxwebgpu is useful to you, please give it a <a href="https://github.com/codecloud-dev/moxwebgpu">star</a> — it helps more people run GPU compute in the browser!</b>
27+
28+
29+
30+
## 🐛 Welcome to roast me
31+
32+
> This is an early-stage project — **bugs exist, and probably plenty of them.** I'm not pretending it's perfect.
33+
> Every pitfall you hit and every gripe you have is a chance to help make it better.
34+
35+
- 💥 Crashed / black screen / won't run? → [File a bug report](https://github.com/codecloud-dev/moxwebgpu/issues)
36+
- 💡 Want a feature? → [Open a feature request](https://github.com/codecloud-dev/moxwebgpu/issues)
37+
- 🗯️ Just want to rant or nitpick? → Issues are welcome too, label it whatever 😄
38+
39+
I read every issue and fix what I can, fast. Let's grow this from "runs" to "delightful" 💪
2740
</p>
2841

2942
<p align="center">

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,19 @@
2525

2626
<p align="center">
2727
<b>⭐ 如果 moxwebgpu 对你有用,欢迎点个 <a href="https://github.com/codecloud-dev/moxwebgpu">Star</a> —— 它能让更多人在浏览器里跑起 GPU 计算!</b>
28+
29+
30+
31+
## 🐛 欢迎来“批斗”我
32+
33+
> 这是个刚起步的项目,**bug 肯定有,而且不少**。我不装完美——
34+
> 你踩到的每一个坑、每一个槽点,都是帮我把它养好的机会。
35+
36+
- 💥 遇到崩溃 / 黑屏 / 跑不起来?→ [提个 Bug 报告](https://github.com/codecloud-dev/moxwebgpu/issues)
37+
- 💡 有想要的功能?→ [开个需求](https://github.com/codecloud-dev/moxwebgpu/issues)
38+
- 🗯️ 单纯想吐槽、挑刺?→ 也欢迎开 issue,标签随便打 😄
39+
40+
每个 issue 我都会看,能修的尽快修。一起把它从“能跑”养到“好用” 💪
2841
</p>
2942

3043
<p align="center">

0 commit comments

Comments
 (0)