Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve issue templates #10038

Merged
merged 8 commits into from Jan 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/BUG.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/DOCS.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/FEATURE.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/SUPPORT.md

This file was deleted.

84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
@@ -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
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -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
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
@@ -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)
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
@@ -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