Skip to content

Add more specific GitHub issue templates #18161

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

Merged
merged 8 commits into from
Aug 13, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
name: Bug Report
about: Report a bug or issue with Matplotlib
---

<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
<!--You can feel free to delete the sections that do not apply.-->

Expand Down
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Documentation improvement
about: Create a report to help us improve the documentation
label: Documentation
---

<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
<!--You can feel free to delete the sections that do not apply.-->

### Problem

<!--
If you are referencing an existing piece of documentation or example please provide a link.

* I found [...] to be unclear because [...]
* [...] made me think that [...] when really it should be [...]
* There is no example showing how to do [...]
-->


### Suggested Improvement

<!--
If you have an idea to improve the documentation please suggest it here

* This line should be be changed to say [...]
* Include a paragraph explaining [...]
* Add a figure showing [...]
-->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Feature Request
about: Suggest something to add to Matplotlib
labels: New feature
---

<!--
Welcome! Thanks for thinking of a way to improve Matplotlib.


Before creating a new feature request please search the issues for relevant feature requests.
-->

### Problem

<!--
Provide a clear and concise description of the problem this feature will solve.

For example:
* I'm always frustrated when [...] because [...]
* I would like it if [...] happened when I [...] because [...]
* Here is a sample image of what I am asking for [...]
-->

### Proposed Solution

<!-- Provide a clear and concise description of a way to accomplish what you want. For example:

* Add an option so that when [...] [...] will happen
-->

### Additional context and prior art

<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:

* Another project [...] solved this by [...]
-->
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Maintenance
about: Help improve performance, usability and/or consistency.
label: Maintenance
---

### Describe the issue

**Summary**

<!-- A short 1-2 sentences that succinctly describe what could be improved -->

### Proposed fix

17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Question/Support/Other
about: If you have a usage question
labels: Community support
# This template is based on the scikit-learn template
# https://github.com/scikit-learn/scikit-learn/blob/8e61534f1087703f476414d8dbd3688282f8eebf/.github/ISSUE_TEMPLATE/usage_question.md
Comment on lines +5 to +6
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going back and forth on whether this needs to be in here...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't show up when someone makes a new issue as it is a comment in the yaml frontmatter rather than in the markdown body. See example here: https://github.com/ianhi/git-expt/issues/new?labels=Question&template=test.md and the source file https://raw.githubusercontent.com/ianhi/git-expt/master/.github/ISSUE_TEMPLATE/test.md

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the clarification.

---

<!--
**If your issue is a usage question, please submit it in one of these other channels instead:**
- The Matplotlib community forum: https://discourse.matplotlib.org/
- StackOverflow with the Matplotlib tag: https://stackoverflow.com/questions/tagged/matplotlib
The issue tracker is used only to report issues and feature requests. For
questions, please use either of the above platforms. Most question issues are
closed without an answer on this issue tracker. Thanks for your understanding.
-->