Skip to content

Commit

Permalink
chore: 优化 issue 模版文案
Browse files Browse the repository at this point in the history
  • Loading branch information
lijinke666 committed Dec 20, 2024
1 parent 9c259c5 commit 4db0c41
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ body:
**这是一个开源项目, 我们也有繁忙的业务要做, 是用自己的业余时间在维护, 为爱发电, 精力有限, 所以有时候 issue 响应速度不是那么及时, 如果你遇到了问题, 或者对 [Issues](https://github.com/antvis/S2/issues) 和 [Discussions](https://github.com/antvis/S2/discussions) 列表的问题感兴趣, 可以直接认领并尝试修复 ([贡献指南](https://s2.antv.antgroup.com/manual/contribution)),帮助 S2 变得更好, 而不是一味的埋怨和催促, 我们不是甲方乙方的关系.**
### 已经停止维护的版本/包
`1.x` 和 `@antv/s2-vue` 现已停止维护,请勿再提交相关的问题, 由于精力投入有限,出于维护成本,包下载量等因素综合考虑,从 `2.0.0` 正式版后不再继续更新,请基于 `@antv/s2` 自行封装,或 fork 仓库进行二次开发社区版本。
- type: textarea
id: version
attributes:
label: 🏷 S2 Version / S2 版本
description: |
请填写你实际安装到 node_modules 中的具体版本号,请确保你已经尝试过安装最新版本解决问题,并且本地和官网都能复现该问题.
请不要写 `latest`, `2.x` 这种没有意义的版本号,
请填写你实际安装到 node_modules 中的具体版本号,请确保你已经尝试过**安装最新版本**解决问题,并且**本地和官网都能复现该问题**.
版本号应该是 `2.1.1` 这种格式, 请不要写 `latest`, `2.x` 这种没有意义的版本号, 对其他查看该 issue 的用户来说没有太大的参数价值.
placeholder: |
复制下方的表格, 修改对应版本号即可:
Expand Down Expand Up @@ -75,10 +79,10 @@ body:
attributes:
label: ⌨️ Code Snapshots / 代码片段
description: |
1. 请粘贴你的**核心代码片段**包括但不限于 `报错信息`, `s2Options 配置信息`, `s2DataConfig 数据源信息`。
2. 请不要粘贴你自己的业务代码, 更不要无脑粘贴一大段没有格式化的 "乱码"。
1. 请粘贴你的**核心代码片段**, 包括但不限于 `报错信息`, `s2Options 配置信息`, `s2DataConfig 数据源信息`。
2. 请不要粘贴你自己的业务代码, 更不要无脑粘贴一大段没有格式化的 "乱码", 请注意使用 markdown code 标签
3. 请不要**直接粘贴官网的在线示例链接, 然后告诉我们有问题, 官网不会保存你编辑后的代码**, 请粘贴 `你的代码片段`, 或者使用 [codesandbox](https://codesandbox.io/)
4. 请尽量不要粘贴代码的截图,请使用文本.
4. 请尽量不要粘贴代码的截图,请使用文本, 方便复制.
placeholder: |
If there is a code block, please use Markdown syntax, such as:
请注意使用 markdown code 标签:
Expand All @@ -94,7 +98,7 @@ body:
attributes:
label: 🔗 Reproduction link / 复现链接
description: |
1. 请提供一个精简的可复现链接,它可以让我们更快的帮你复现,定位问题,这很重要,尽量避免 gif, 视频等形式。
1. 请提供一个精简的最小可复现链接,尽量去除你的业务代码, 它可以让我们更快的帮你复现,定位问题,这很重要,尽量避免 gif, 视频等形式。
2. 推荐使用 [codesandbox](https://codesandbox.io/), 我们提供了各种版本的模板,方便你反馈问题。[查看所有模板](https://www.yuque.com/antv/vo4vyz/bam4vz)。
3. [官网在线示例](https://s2.antv.vision/zh/examples/gallery) 支持在线编写代码,你可以将代码转成 `codesandbox` 并将对应的链接发给我们,请不要将官网的代码原封不动的复制给我们,请不要 `这么麻烦, 还要复现链接? 赶紧给我修啊, 很急!`, 请不要 `打了一个压缩包给你, 代码都在这, 给我修吧`,更不要 `复现步骤,联系 [email protected]`。
4. 请不要 `开局一张图,内容全靠猜`, 我们不是侦探
Expand Down

0 comments on commit 4db0c41

Please sign in to comment.