Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Make issue templates fancier * should be valid yml now * remove title field * remove reproducable sample for docs * add example back to docs, change link for plugin and add TS link for TS issues * wrong labels, forgot type: in front of it * implement feedback * gramar, missing word
- Loading branch information
1 parent
c527f47
commit 51b051f
Showing
8 changed files
with
148 additions
and
127 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
name: Bug Report | ||
description: Something went awry | ||
labels: ["type: bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Need help or support? | ||
Please don't open an issue! Head to https://stackoverflow.com/questions/tagged/chart.js. | ||
- type: markdown | ||
attributes: | ||
value: "Bug reports MUST be submitted with an interactive example: https://codepen.io/pen?template=BapRepQ." | ||
|
||
- type: markdown | ||
attributes: | ||
value: Chart.js versions lower then 3.x are NOT supported anymore, new issues will be disregarded. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: Tell us what should happen. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Current behavior | ||
description: Tell us what happens instead of the expected behavior. | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Reproducible sample | ||
description: | | ||
Please provide issue reproduction. | ||
You can use [this codepen](https://codepen.io/pen?template=BapRepQ) to make a reproducible sample. | ||
Major framework wrappers for chart.js templates: | ||
[vue-chart-3 sandbox (Vue)](https://codesandbox.io/s/vue-chart-3-chart-js-issue-template-bpg7k?file=/src/App.vue) | ||
[ng2-charts sandbox (Angular)](https://codesandbox.io/s/ng2charts-chart-js-issue-template-fhezt?file=/src/app/app.component.ts) | ||
[react-chartjs-2 sandbox (React)](https://codesandbox.io/s/react-chartjs-2-chart-js-issue-template-cg7b5?file=/src/App.tsx) | ||
For typescript issues you can make use of [this TS Playground](https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAbzgYQBYENZwL5wGZQQhwDkAxhrAHQBWAziQNwCwAUGwG6ZxkwAecALxwAJhDIBXEAFMAdjCoBzaTACiAG2kz5AIQCeASREAKAEQg9aTDFMBKOOjpwAEgBUAsgBlk6WVzoaWnIwLKxcUHAWVljCstIA7iiUMMa8fAA0iGxwOXAwemDSAFyk6sBxJOnZuSLoMOglCNW5ueroAEbS6nQlANqmAErSIqaZpjrqEtKjcKYAml3qEPEzpgDiUNJyqwAKElBgmqsA8lC+yqYAulWsLS219XQqPXC9Tbd3n22d6iUkAMRwCB4OAANQgMGkDBun0+DwarwAjAAmTKIgCcmQAzJkAKyZVFwLHXZp3bCXUnYGG5CBgGDACCyF7vT50MjoTTM0ktPiNbl3fk5KmCuB6PkfWFwEXYfkyiU4NjYWyMIA) to make a reproducible sample. | ||
If filing a bug against `master`, you may reference the latest code via | ||
https://www.chartjs.org/dist/master/chart.min.js (changing the filename to | ||
point at the file you need as appropriate). Do not rely on these files for | ||
production purposes as they may be removed at any time. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Optional extra steps/info to reproduce | ||
|
||
- type: textarea | ||
attributes: | ||
label: Possible solution | ||
description: If you have suggestions on a fix for the bug. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Context | ||
description: | | ||
How has this issue affected you? What are you trying to accomplish? | ||
Providing context helps us come up with a solution that is most useful in the real world. | ||
- type: input | ||
attributes: | ||
label: chart.js version | ||
description: Which version of `chart.js` are you using? | ||
placeholder: "v0.0.0" | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Browser name and version | ||
|
||
- type: input | ||
attributes: | ||
label: Link to your project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Support, Help, and Advice | ||
url: https://stackoverflow.com/questions/tagged/chart.js | ||
about: Need help or support? Head to https://stackoverflow.com/questions/tagged/chart.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: Documentation | ||
description: Are the docs lacking or missing something? | ||
labels: ["type: documentation"] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: "Documentation Is:" | ||
options: | ||
- label: Missing or needed? | ||
- label: Confusing | ||
- label: Not sure? | ||
|
||
- type: textarea | ||
attributes: | ||
label: Please Explain in Detail... | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Your Proposal for Changes | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Example | ||
description: | | ||
Provide a link to a live example demonstrating the issue or feature to be documented: | ||
Normal: https://codepen.io/pen?template=BapRepQ | ||
TS: [TS Playground](https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAbzgYQBYENZwL5wGZQQhwDkAxhrAHQBWAziQNwCwAUGwG6ZxkwAecALxwAJhDIBXEAFMAdjCoBzaTACiAG2kz5AIQCeASREAKAEQg9aTDFMBKOOjpwAEgBUAsgBlk6WVzoaWnIwLKxcUHAWVljCstIA7iiUMMa8fAA0iGxwOXAwemDSAFyk6sBxJOnZuSLoMOglCNW5ueroAEbS6nQlANqmAErSIqaZpjrqEtKjcKYAml3qEPEzpgDiUNJyqwAKElBgmqsA8lC+yqYAulWsLS219XQqPXC9Tbd3n22d6iUkAMRwCB4OAANQgMGkDBun0+DwarwAjAAmTKIgCcmQAzJkAKyZVFwLHXZp3bCXUnYGG5CBgGDACCyF7vT50MjoTTM0ktPiNbl3fk5KmCuB6PkfWFwEXYfkyiU4NjYWyMIA) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: Feature Request | ||
description: Suggest an idea | ||
labels: ["type: enhancement"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Most features should start as plugins outside of Chart.js | ||
(https://www.chartjs.org/docs/latest/developers/plugins.html). | ||
Please consider whether your changes are useful for all users, or if this is | ||
specific to your usecase and a Chart.js plugin would be more appropriate. | ||
Need help or tech support? Please don't open an issue! | ||
Head to https://stackoverflow.com/questions/tagged/chart.js | ||
- type: textarea | ||
attributes: | ||
label: Feature Proposal | ||
description: | | ||
What are you trying to accomplish? | ||
Providing context helps us come up with a solution that is most useful in the real world | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Possible Implementation | ||
description: Not obligatory, but suggest ideas for how to implement the addition or change |