Skip to content

Commit

Permalink
Merge pull request apache#16128 from pissang/master
Browse files Browse the repository at this point in the history
Use github issue form for submitting issues.
  • Loading branch information
pissang authored Nov 29, 2021
2 parents 790687d + 0b99272 commit 01a25f4
Show file tree
Hide file tree
Showing 4 changed files with 146 additions and 10 deletions.
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

101 changes: 101 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
name: Bug Report
description: Report your bug to Apache ECharts
title: "[Bug]: "
labels: [bug]
body:
- type: markdown
attributes:
value: |
The issue list is reserved exclusively for bug reports.
For usage questions, please use the following resources:
- Read the [docs](http://echarts.apache.org/option.html)
- Find in [examples](https://echarts.apache.org/examples/)
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/echarts)
For non-technical support or general questions, you can email [[email protected]](mailto:[email protected]). And don't forget to subscribe our [mailing list](https://echarts.apache.org/en/maillist.html) to get updated with the project.
Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue.
# - type: checkboxes
# attributes:
# label: Is there an existing issue for this?
# description: Please search to see if an issue already exists for the bug you encountered.
# options:
# - label: I have searched the existing issues
# required: true

- type: input
attributes:
label: Version
description: |
Check if the issue is reproducible with the latest stable version of Apache ECharts.
placeholder: |
e.g. 5.2.2
validations:
required: true

- type: input
attributes:
label: Link to minimal reproduction
description: |
If the reproduction does not need a build setup, please provide a link to a [JSFiddle](https://jsfiddle.net/cnBob/ndk8642w/2/), [JSBin](https://jsbin.com/) or [CodePen](https://codepen.io). If it requires a build setup, you can use [CodeSandbox](https://codesandbox.io/) or provide a GitHub repo.
validations:
required: false

- type: textarea
attributes:
label: Steps To Reproduce
description: |
What do we need to do after opening your repro in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
placeholder: |
1. How do you create your chart.
2. What's the echarts option you are using.
3. User interactions before the error happens.
validations:
required: true

- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: macOS Monterey
- **Browser**: Chrome 96.0.4664.55
- **Framework** Vue@3
value: |
- OS:
- Browser:
- Framework:
render: markdown

validations:
required: false

- type: textarea
attributes:
label: Any additional comments?
description: |
e.g. some background/context of how you ran into this bug.
validations:
required: false
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false

# contact_links:
# - name: Apache ECharts Doc
# url: https://echarts.apache.org/option.html
# about: Please search question here before opening a new issue
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature Request
description: File a bug/issue
title: "[Feature]: "
labels: [new-feature]
body:
- type: markdown
attributes:
value: |
The issue list is reserved exclusively feature requests.
For usage questions, please use the following resources:
- Read the [docs](http://echarts.apache.org/option.html)
- Find in [examples](https://ecomfe.github.io/echarts-examples/public/index.html)
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/echarts)
For non-technical support or general questions, you can email [[email protected]](mailto:[email protected]). And don't forget to subscribe our [mailing list](https://echarts.apache.org/en/maillist.html) to get updated with the project.
Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue.
- type: textarea
attributes:
label: What Problem Does This Feature Solve
description: |
Explain your use case, context, and rationale behind this feature request. More importantly, what is the end user experience you are trying to build that led to the need for this feature?
An important design goal of ECharts is keeping the API surface small and straightforward. In general, we only consider adding new features that solve a problem that cannot be easily dealt with using existing APIs (i.e. not just an alternative way of doing things that can already be done). The problem should also be common enough to justify the addition.
validations:
required: true

- type: textarea
attributes:
label: What does the proposed API look like?
description: Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. Note that you can use [Markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format your code blocks.


validations:
required: true

0 comments on commit 01a25f4

Please sign in to comment.