Skip to content

Commit

Permalink
chore: update issue template (#6579)
Browse files Browse the repository at this point in the history
* chore: update issue template

* chore: update issue template
  • Loading branch information
Aarebecca authored Nov 29, 2024
1 parent 7193fb7 commit 3ef6d94
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 89 deletions.
74 changes: 30 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,96 +1,82 @@
name: '🐞 Bug report'
description: Create a report to help us improve, Ask questions in Discussions / 创建一个问题报告以帮助我们改进,提问请到 Discussions
title: '[Bug]: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue :pray:.
This issue tracker is for reporting bugs found in G6.
**⚠️ If you have a question about how to achieve something and are struggling, please post a question
inside of G6's [Discussions](https://github.com/antvis/G6/discussions).**
Report errors and exceptions found in G6.
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
- [G6 Issues](https://github.com/antvis/G6/issues)
- [G6 Closed Issues](https://github.com/antvis/G6/issues?q=is%3Aissue+is%3Aclosed)
- [G6 Discussions](https://github.com/antvis/G6/discussions)
The more information you fill in, the better the community can help you.
---
感谢您报告问题 :pray:
反馈在 G6 中发现的错误、异常
此问题跟踪器用于报告在 G6 中发现的错误。
**⚠️ 如果您对如何实现某些功能有疑问并且遇到困难,请在 G6 的 [Discussions](https://github.com/antvis/G6/discussions) 中发布问题。**
在提交新 issue 之前,先通过以下链接检查是否存在相同问题:
在提交新 issue 之前,先通过以下链接查看有没有类似的问题:
- [G6 Issues](https://github.com/antvis/G6/issues)
- [G6 Closed Issues](https://github.com/antvis/G6/issues?q=is%3Aissue+is%3Aclosed)
- [G6 Discussions](https://github.com/antvis/G6/discussions)
> [Issues](https://github.com/antvis/G6/issues) | [Closed Issues](https://github.com/antvis/G6/issues?q=is%3Aissue+is%3Aclosed) | [Discussions](https://github.com/antvis/G6/discussions)
您提供的信息越多,社区就能更好地帮助您。
- type: textarea
id: description
attributes:
label: Describe the bug / 问题描述
description: Describe your problem succinctly and clearly / 简洁清晰地描述你遇到的问题
placeholder: |
If there is a code block, please use Markdown syntax, such as:
如包含代码块,请使用 Markdown 语法,如:
```javascript
// Your code here
```
validations:
required: true
- type: input
id: link
attributes:
label: Reproduction link / 重现链接
description: |
Please provide a link to reproduce the problem / 请提供重现问题的链接
label: Reproduction link / 复现链接
placeholder: |
e.g. CodeSandbox or StackBlitz URL / 例如 CodeSandbox 或 StackBlitz 链接
CodeSandbox / StackBlitz / ...
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue / 重现步骤
description: Describe the steps we have to take to reproduce the behavior / 描述重现问题的步骤
validations:
required: false
- type: dropdown
id: version
attributes:
label: G6 Version / G6 版本
options:
- Please select / 请选择
- 🆕 5.x
- 4.x
- 3.x or below / 3.x 或更低版本
- 3.x
validations:
required: true
- type: dropdown
- type: checkboxes
id: OS
attributes:
label: Operating System / 操作系统
multiple: true
label: OS / 操作系统
options:
- macOS
- Windows
- Linux
- Others / 其他
- label: macOS
- label: Windows
- label: Linux
- label: Others / 其他
validations:
required: true
- type: dropdown
- type: checkboxes
id: Browser
attributes:
label: Browser / 浏览器
multiple: true
options:
- Chrome
- Edge
- Firefox
- Safari (Limited support / 有限支持)
- IE (Nonsupport / 不支持)
- Others / 其他
- label: Chrome
- label: Edge
- label: Firefox
- label: Safari (Limited support / 有限支持)
- label: IE (Nonsupport / 不支持)
- label: Others / 其他
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context / 补充说明
description: Add any other context about the problem here / 添加关于问题的其他上下文
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Ref: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: false
contact_links:
- name: Question / 问题咨询
url: https://github.com/antvis/g6/discussions/new?category=q-a
about: Discuss G6 usage / 讨论 G6 使用问题
- name: Join Discussion Group / 加入讨论群
url: https://qr.dingtalk.com/action/joingroup?code=v1,k1,rQHsK/OOTPX8ixM/DaXcL3goIYpnpKr/AFIonmA1SOM=&_dt_no_comment=1&origin=11?
about: Join DingTalk discussion group / 加入钉钉讨论群
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: '💡 Feature Request'
description: I have a suggestion (and may want to implement it) / 我有一个建议(或者想参与贡献)
title: '[Feat]: '
labels: ['feature']
body:

- type: textarea
id: description
attributes:
label: Describe the feature / 功能描述
validations:
required: true

- type: dropdown
attributes:
label: Are you willing to contribute? / 是否愿意参与贡献?
options:
- Please select / 请选择
- ✅ Yes / 是
- ❌ No / 否
validations:
required: true
90 changes: 45 additions & 45 deletions .github/ISSUE_TEMPLATE/oscp.yml
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
name: 'AntV OSCP 计划 / AntV OSCP Plan'
description: AntV 开源共建计划(仅供管理员使用) / AntV Open Source Contribution Plan(For administrators only)
body:
- type: checkboxes
id: AntV_OSCP_program
attributes:
label: AntV Open Source Contribution Plan(可选/Optional)
description: |
AntV 开源共建计划期望可以基于 AntV 的开源 Roadmap 开放具体开发任务到社区,以社区共建任务的形式推动“AntV” 的开源发展,也期望有更多社区伙伴各各种形式参与到 AntV 的开源共建中,共同参与数据可视化开源生态的持续建设。
AntV Open Source Contribution Plan expects to open specific development tasks to the community based on AntV's open source roadmap, promote the open source development of "AntV" in the form of community co-construction tasks, and also hope that more community partners will participate in AntV's open source co-construction in various forms, and jointly participate in the continuous construction of the data visualization open source ecosystem.
# name: 'AntV OSCP 计划 / AntV OSCP Plan'
# description: AntV 开源共建计划(仅供管理员使用) / AntV Open Source Contribution Plan(For administrators only)
# body:
# - type: checkboxes
# id: AntV_OSCP_program
# attributes:
# label: AntV Open Source Contribution Plan(可选/Optional)
# description: |
# AntV 开源共建计划期望可以基于 AntV 的开源 Roadmap 开放具体开发任务到社区,以社区共建任务的形式推动“AntV” 的开源发展,也期望有更多社区伙伴各各种形式参与到 AntV 的开源共建中,共同参与数据可视化开源生态的持续建设。
# AntV Open Source Contribution Plan expects to open specific development tasks to the community based on AntV's open source roadmap, promote the open source development of "AntV" in the form of community co-construction tasks, and also hope that more community partners will participate in AntV's open source co-construction in various forms, and jointly participate in the continuous construction of the data visualization open source ecosystem.

若有感兴趣想要认领的任务,可直接回复认领,如果你是首次认领可先完成初级入门任务。
If you are interested in claiming a task, you can directly reply to claim it. If you are claiming for the first time, you can complete the primary entry task first.
# 若有感兴趣想要认领的任务,可直接回复认领,如果你是首次认领可先完成初级入门任务。
# If you are interested in claiming a task, you can directly reply to claim it. If you are claiming for the first time, you can complete the primary entry task first.

options:
- label: 我同意将这个 Issue 参与 OSCP 计划 / I agree to participate in the OSCP plan
validations:
required: false
- type: dropdown
id: issue_oscp_difficulty
attributes:
label: Issue 类型 / Issue Type
options:
- 初级任务 / Primary Task
- 中级任务 / Intermediate Task
- 高级任务 / Advanced Task
- 专家任务 / Expert Task
validations:
required: false
- type: textarea
id: oscp_task_description
attributes:
label: 任务介绍 / Task Description
description: |
简单描述任务背景信息,为了解决哪些问题
Briefly describe the background information of the task and what problems to solve
validations:
required: false
- type: textarea
id: oscp_task_info_ref
attributes:
label: 参考说明 / Reference Description
description: |
提供一些可参考的 demo,相关教程辅助用户解决问题
Provide some demos and related tutorials for users to solve problems
validations:
required: false
# options:
# - label: 我同意将这个 Issue 参与 OSCP 计划 / I agree to participate in the OSCP plan
# validations:
# required: false
# - type: dropdown
# id: issue_oscp_difficulty
# attributes:
# label: Issue 类型 / Issue Type
# options:
# - 初级任务 / Primary Task
# - 中级任务 / Intermediate Task
# - 高级任务 / Advanced Task
# - 专家任务 / Expert Task
# validations:
# required: false
# - type: textarea
# id: oscp_task_description
# attributes:
# label: 任务介绍 / Task Description
# description: |
# 简单描述任务背景信息,为了解决哪些问题
# Briefly describe the background information of the task and what problems to solve
# validations:
# required: false
# - type: textarea
# id: oscp_task_info_ref
# attributes:
# label: 参考说明 / Reference Description
# description: |
# 提供一些可参考的 demo,相关教程辅助用户解决问题
# Provide some demos and related tutorials for users to solve problems
# validations:
# required: false

0 comments on commit 3ef6d94

Please sign in to comment.