Skip to content

Commit 1719b08

Browse files
authored
chore: refresh community contribution templates (#218)
* chore: refresh community contribution templates * fix: use compatible screenshot field
1 parent 053b970 commit 1719b08

6 files changed

Lines changed: 86 additions & 75 deletions

File tree

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
name: Bug 报告
2-
description: 报告工具的问题或错误
1+
name: Bug 报告 / Bug report
2+
description: 报告可复现的工具故障 / Report a reproducible problem
33
title: '[Bug] '
44
labels: ['bug']
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
感谢你花时间报告 Bug!请尽可能详细地描述问题。
9+
感谢你花时间报告 Bug!请先确认问题在最新在线版本中仍可复现。
10+
Thanks for reporting a bug. Please confirm it still reproduces on the latest live version.
1011
1112
- type: input
1213
id: tool
1314
attributes:
14-
label: 相关工具
15-
description: 哪个工具出现了问题?
16-
placeholder: '例如:JSON 格式化、时间戳转换'
15+
label: 工具链接 / Tool URL
16+
description: 请粘贴出现问题的完整 URL。
17+
placeholder: 'https://tools.realtime-ai.chat/tools/dev/json-formatter.html'
1718
validations:
1819
required: true
1920

2021
- type: textarea
2122
id: description
2223
attributes:
23-
label: 问题描述
24+
label: 问题描述 / Description
2425
description: 请清晰描述遇到的问题
2526
placeholder: 描述你遇到的问题...
2627
validations:
@@ -29,7 +30,7 @@ body:
2930
- type: textarea
3031
id: reproduce
3132
attributes:
32-
label: 复现步骤
33+
label: 复现步骤 / Steps to reproduce
3334
description: 如何复现这个问题?
3435
placeholder: |
3536
1. 打开 '...'
@@ -42,15 +43,15 @@ body:
4243
- type: textarea
4344
id: expected
4445
attributes:
45-
label: 期望行为
46+
label: 期望行为 / Expected behavior
4647
description: 你期望发生什么?
4748
validations:
4849
required: true
4950

5051
- type: dropdown
5152
id: browser
5253
attributes:
53-
label: 浏览器
54+
label: 浏览器 / Browser
5455
options:
5556
- Chrome
5657
- Firefox
@@ -60,20 +61,42 @@ body:
6061
validations:
6162
required: true
6263

64+
- type: input
65+
id: browser_version
66+
attributes:
67+
label: 浏览器版本 / Browser version
68+
placeholder: '例如:Chrome 140, Safari 19'
69+
6370
- type: input
6471
id: os
6572
attributes:
66-
label: 操作系统
73+
label: 操作系统 / Operating system
6774
placeholder: '例如:Windows 11, macOS 14, Ubuntu 22.04'
6875

76+
- type: textarea
77+
id: console
78+
attributes:
79+
label: 控制台或网络错误 / Console or network errors
80+
description: 如果可以,请粘贴相关错误;提交前请移除令牌、个人数据和敏感内容。
81+
6982
- type: textarea
7083
id: screenshots
7184
attributes:
72-
label: 截图
85+
label: 截图 / Screenshots
7386
description: 如果有的话,请添加截图帮助说明问题
7487

7588
- type: textarea
7689
id: additional
7790
attributes:
78-
label: 其他信息
91+
label: 其他信息 / Additional context
7992
description: 任何其他可能有用的信息
93+
94+
- type: checkboxes
95+
id: checks
96+
attributes:
97+
label: 提交前确认 / Pre-flight checks
98+
options:
99+
- label: 我已在最新在线版本中复现该问题。
100+
required: true
101+
- label: 我已移除输入、截图和日志中的敏感信息。
102+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: 使用问题
3+
- name: 使用问题 / Questions
44
url: https://github.com/chicogong/html-tools/discussions
5-
about: 使用问题请到 Discussions 讨论
6-
- name: 在线体验
5+
about: 使用帮助、想法交流与一般问答请到 Discussions。 Ask usage questions and discuss ideas here.
6+
- name: 在线体验 / Live site
77
url: https://tools.realtime-ai.chat
8-
about: 直接访问在线工具
8+
about: 在提交问题前先尝试最新在线版本。 Try the latest deployed version before filing an issue.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
name: 功能请求
2-
description: 建议新工具或新功能
1+
name: 功能请求 / Feature request
2+
description: 建议改进现有工具或项目体验 / Suggest an improvement
33
title: '[Feature] '
44
labels: ['enhancement']
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
感谢你的建议!我们很乐意听取你的想法。
9+
感谢你的建议!新工具请使用单独的“新工具提议”表单。
10+
Thanks for the idea. Please use the dedicated new-tool form for a new tool.
1011
1112
- type: dropdown
1213
id: type
1314
attributes:
1415
label: 请求类型
1516
options:
16-
- 新工具
1717
- 现有工具改进
1818
- 界面/体验优化
19+
- 文档/翻译改进
20+
- 开发与维护流程
1921
- 其他
2022
validations:
2123
required: true
2224

2325
- type: textarea
2426
id: description
2527
attributes:
26-
label: 功能描述
28+
label: 功能描述 / Proposed improvement
2729
description: 请描述你希望添加的功能
2830
placeholder: 清晰描述这个功能...
2931
validations:
@@ -32,7 +34,7 @@ body:
3234
- type: textarea
3335
id: problem
3436
attributes:
35-
label: 解决的问题
37+
label: 解决的问题 / Problem to solve
3638
description: 这个功能解决什么问题?
3739
placeholder: 我在 [...] 时遇到困难...
3840

.github/ISSUE_TEMPLATE/new_tool.yml

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
name: 新工具提议
2-
description: 提议添加新的在线工具
1+
name: 新工具提议 / New tool proposal
2+
description: 提议一个聚焦、可维护的浏览器工具 / Propose a focused browser tool
33
title: '[Tool] '
4-
labels: ['new-tool']
4+
labels: ['enhancement']
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
有好的工具想法?太棒了!请告诉我们你想要什么工具。
9+
有好的工具想法?请说明它解决的具体任务、数据边界和现有替代方案。
10+
Have a tool idea? Describe its focused job, data boundary, and existing alternatives.
1011
1112
- type: input
1213
id: tool_name
@@ -16,24 +17,12 @@ body:
1617
validations:
1718
required: true
1819

19-
- type: dropdown
20+
- type: input
2021
id: category
2122
attributes:
22-
label: 工具分类
23-
options:
24-
- 开发工具 (dev)
25-
- 文本工具 (text)
26-
- 时间工具 (time)
27-
- 生成器 (generator)
28-
- 媒体工具 (media)
29-
- 计算器 (calculator)
30-
- 转换器 (converter)
31-
- 提取器 (extractor)
32-
- AI 工具 (ai)
33-
- 网络工具 (network)
34-
- SEO 工具 (seo)
35-
- 安全工具 (security)
36-
- 新分类
23+
label: 工具分类 / Category
24+
description: 可填写首页中的现有分类,或说明需要一个新分类。
25+
placeholder: '例如:开发工具 (dev) / 新分类:…'
3726
validations:
3827
required: true
3928

@@ -73,15 +62,27 @@ body:
7362
label: 参考实现
7463
description: 类似工具或参考链接(可选)
7564

76-
- type: checkboxes
77-
id: requirements
65+
- type: dropdown
66+
id: data_boundary
7867
attributes:
79-
label: 技术要求
80-
description: 这个工具需要
68+
label: 数据与网络边界 / Data and network boundary
69+
description: 最接近预期实现的选项是
8170
options:
82-
- label: 可以纯前端实现(无需后端)
83-
- label: 数据可以完全在本地处理
84-
- label: 可以离线使用
71+
- 完全在当前页面本地处理
72+
- 使用浏览器权限或设备 API
73+
- 请求用户指定或项目明示的外部服务
74+
- 加载 CDN、字体、图像或公开数据源
75+
- 尚不确定
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
id: privacy
81+
attributes:
82+
label: 隐私说明 / Privacy notes
83+
description: 哪些输入会离开浏览器?依赖哪些外部资源?如不需要,请写“全部本地处理”。
84+
validations:
85+
required: true
8586

8687
- type: checkboxes
8788
id: contribution

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
## 描述 (Description)
1+
## 描述 / Description
22

33
请清晰且简洁地描述这个 PR 所做的修改。
44
如果是修复 Bug,请附带相关的 Issue 编号。
55

66
Fixes # (issue)
77

8-
## 检查清单 (Checklist)
8+
## 验证 / Validation
9+
10+
列出实际运行的命令、浏览器检查和未覆盖的风险。
11+
12+
## 检查清单 / Checklist
913

1014
提交 PR 之前,请确保你已经核对以下项目:
1115

12-
- [ ] 我的代码遵循此项目的样式和指导原则
13-
- [ ] 我已经运行了 `npm run lint``npm run format:check`,且未发现任何错误
16+
- [ ] 我已运行 `npm run build && npm test && npm run lint && npm run format:check`
17+
- [ ] 我已检查 `git diff` / `git status --short`,差异只包含本 PR 预期改动
1418
- [ ] (如果是新工具)我已经将其录入到 `tools.json` 并运行了 `npm run sync:tools`
15-
- [ ] (如果是新工具)我已经为其在 `tools.json` 中认真撰写了吸引人的 `description` 以优化 SEO 搜索引擎收录。
19+
- [ ] (如果是新工具)我已写明本地处理、浏览器权限、外部 API 和 CDN 依赖等数据边界。
20+
- [ ] (如果改动交互)我已运行相关 `npm run test:e2e` 或说明手动浏览器验证。
1621
- [ ] 我已经进行了自我代码审查。
17-
- [ ] (如果适用)我添加了适当的注释,尤其是在难以理解的区域。

0 commit comments

Comments
 (0)