Add more specific GitHub issue templates #18161

ianhi · 2020-08-03T16:18:47Z

PR Summary

Added a feature request template that will automatically be tagged with the New Feature label.
Moved ISSUE_TEMPLATE.MD to ISSUE_TEMPLATE/bug_report.md so that both issue templates will show up as options for opening a new issue.

The feature request template is an almost exact copy of the jupyterlab template but I wrote the jupyterlab version so I think it's fine to just copy it w/o attribution.

ping @story645

PR Checklist

na Has Pytest style unit tests
na Code is Flake 8 compliant
na New features are documented, with examples if plot related
na Documentation is sphinx and numpydoc compliant
na Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
na Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way

I also moved the ISSUE_TEMPLATE.md to ISSUE_TEMPLATE/bug_report.md so that both feature requests and bug report templates will show up after clicking the new issue button

story645 · 2020-08-03T16:29:41Z

Thanks for opening this!
For reference for other folk looking at this PR, went back into the MPL meeting notes and the discussion around this was to adopt the sklearn model (pandas does something similar/ it seems to be kinda standard). These are what was agreed upon:

Bug / Crash: Something is happening that clearly shouldn’t happen. Wrong results as well as unexpected errors from estimators go here.
Cleanup / Enhancement: Improving performance, usability, consistency.
Documentation: Missing, incorrect or sub-standard documentations and examples.
New Feature: Feature requests and pull requests implementing a new feature.

jklymak · 2020-08-03T21:26:52Z

@story645 are you asking for all these categories to be implimented? Whats the next step here?

story645 · 2020-08-03T23:59:51Z

No, just the Bug and New Feature is great! I'm just putting this here cause we already agreed on it on a call and it's kind of a pain to pull up.

jklymak · 2020-08-04T00:26:55Z

.github/ISSUE_TEMPLATE/feature_request.md

+* Add an option so that when [...]  [...] will happen
+ -->
+
+### Additional context


Suggested change

### Additional context

### Additional context and prior art

jklymak · 2020-08-04T00:34:19Z

.github/ISSUE_TEMPLATE/feature_request.md

+---
+
+<!--
+Welcome! Thanks for thinking of a way to improve Matplotlib. If this solves a problem for you, then it probably solves that problem for lots of people! So the whole community will benefit from this request.


please fix the line breaks....

I'd just shorten to Thanks for thinking of a way to improve Matplotlib. and leave off the rest.

please fix the line breaks....

Do you mean inside the paragraph or do you mean how the text is positioned relative to to the comment lines?

Just we wrap most lines at 79 characters. Of course not as big a deal with a markdown file, but...

got it. Would you be open to avoiding that rule in the issue templates? As they are prose rather than code I think it makes more sense for the github issue editor/browser to handle the reflow/wrapping. For example the line wrapping at 79 characters in the current issue template feels unnatural to me:

There are a few other places in the feature request template where I went over 79 lines, and the existing bug_report template seems to have inconsistent enforcement of this.

I don't feel strongly about this, but others do. I think unless there is a good reason (i.e. it'll make horrible line continuations) we stick to 79 characters.

ianhi · 2020-08-04T03:56:56Z

I added a template for each of @story645's suggestions. I used the Enhancement label for the enhancement as that felt most natural but it does not seem to exist as a label currently. If there is a better label to use please let me know and I will change it.

story645 · 2020-08-04T03:58:54Z

Thanks! Maintenance is probably the best fit for those sorts of things.
(Sorry didn't read the first time if you're getting some conflicting emails)

dopplershift · 2020-08-04T04:04:08Z

I don't want to bikeshed this PR to death, but to me "Enhancement" != "maintenance". You don't enhance your car by changing its oil, but it is maintenance. I'd say add the new label, but I'm content to be told how wrong I am. 😉

story645 · 2020-08-04T14:29:08Z

Ryan these are for clean ups & enhancements, which I think folks have been tagging maintenance? There's a seperate issue template for new features and we just discussed on the call how we don't want a standalone enhancement tag cause nobody knew what it was for.

jklymak · 2020-08-04T15:07:51Z

I would not include the "Enhancement.md" at all. We already have "Bug or issue" and "New Feature", and its hard to think of an "enhancement" request not covered under one of those two templates.

story645 · 2020-08-04T16:06:06Z

From the July 20th meeting notes

replace "enhancement" with "new feature"

new feature makes new API
performance enhancement & maintenance clean up code

& this would be for stuff tagged https://github.com/matplotlib/matplotlib/issues?q=is%3Aissue+is%3Aopen+label%3Amaintenance

jklymak · 2020-08-04T16:53:13Z

I'm confused about what you are trying to say @story645. Are you arguing for keeping enhancement.md in this PR or removing it?

story645 · 2020-08-04T17:05:59Z

I'm confused about what you are trying to say @story645. Are you arguing for keeping enhancement.md in this PR or removing it?

keeping it as a template for maintenance type issues

jklymak · 2020-08-04T17:30:03Z

Which recent issues do you wish the user had used the proposed "Maintenance" template for? Because I don't see the benefit from the user's point of view.

story645

minor nitpicks but can also be handled by anybody else when they tweak the templates.

.github/ISSUE_TEMPLATE/documentation.md

.github/ISSUE_TEMPLATE/enhancement.md

.github/ISSUE_TEMPLATE/feature_request.md

ianhi · 2020-08-04T23:18:48Z

Is there any harm in having 1~2 more issue templates? The difficulty here seems to be derived from the lumping of enhancement and cleanup together. How about splitting them up, giving a breakdown like this:

feature request new api
enhancement performance improvement or other small improvment
- I often feel weird calling a request for small improvements a "feature request" so having a dedicated enhancement makes sense to me.
clean-up correct inconsistencies

I think the initial issue I raised for this is a good example of enhancement while the following would be a good example of cleanup:

The acceptable usage of gitter is different on the matplotlib website:

vs on the readme:

Co-Authored-By: hannah <story645@users.noreply.github.com>

QuLogic · 2020-08-05T00:34:03Z

Can we also add something like "I don't know what I want" that redirects to Discourse?

story645 · 2020-08-05T03:47:51Z

@QuLogic some other projects make a "question/support/other" type template that explicitly says something like the issue tracker isn't for this sort of thing so we're most likely going to close this issue and you should use one of our other channels instead.

Here's the scikit-learn version:
https://www.github.com/scikit-learn/scikit-learn/tree/master/.github%2FISSUE_TEMPLATE%2Fusage_question.md

ianhi · 2020-08-09T03:08:47Z

So in summary the conclusion is to have the following:

bug report
feature request new api
documentation Missing, incorrect or sub-standard documentations and examples.
enhancement performance improvement or other small improvment
clean-up correct inconsistencies
"question/support/other redirect to Discourse

Is that a fair assement? If yes, shall I set the label for enhancement to enhancement and use the maintenance label for cleanup? I think this may require action by someone to actually create the label.

QuLogic · 2020-08-10T20:57:10Z

I think we might have crossed wires a bit. We don't have an enhancement label and in fact, we deleted it recently as it seem New feature was more indicative of what it meant.

For performance and small improvements, we can lump that together with cleanup and label it maintenance. While we do have a separate performance label, the number of such PRs is much smaller, so I think it's not a great burden to add that label after the PR is opened. If it does turn out to be a burden, we can always add another template type later.

And to answer another question, Enhancement != Maintenance, but the difference here is a matter of scope. If it's an Enhancement that requires a What's new entry (maybe also for API notes too), then the Enhancement is a New feature. If it's an Enhancement that makes the library 'better' (for some definition of 'better'), but isn't user-visible, we'll call it Maintenance.

QuLogic · 2020-08-10T20:58:49Z

In terms of concrete to-do:

merge enhancement and cleanup and call it maintenance (with that label), but try to avoid calling it an Enhancement
add question/support/other redirect to Discourse

QuLogic

Not sure if labels are case-sensitive.

.github/ISSUE_TEMPLATE/questions.md

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/maintenance.md

.github/ISSUE_TEMPLATE/questions.md

case sensitivity. Also put discourse link before SO to prioritize it.

.github/ISSUE_TEMPLATE/documentation.md

I belive that the line at the top would have stopped github from picking this up as a valid template.

ianhi · 2020-08-12T01:28:52Z

This is the only one with a period.

not only that but there was an extra line at the top of the file that I believe would have caused github to not pick up the template. I think they all should be good now

story645 · 2020-08-12T19:53:01Z

.github/ISSUE_TEMPLATE/questions.md

+# This template is based on the scikit-learn template
+# https://github.com/scikit-learn/scikit-learn/blob/8e61534f1087703f476414d8dbd3688282f8eebf/.github/ISSUE_TEMPLATE/usage_question.md


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

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

thanks for the clarification.

story645 · 2020-08-13T17:49:11Z

Thank you @ianhi for knocking something off my to do list 😉!

ianhi · 2020-08-13T18:29:07Z

Thanks @story645 for helping get it through! I really appreciate having nice templates when I open an issue

add feature request template

6a3f55a

I also moved the ISSUE_TEMPLATE.md to ISSUE_TEMPLATE/bug_report.md so that both feature requests and bug report templates will show up after clicking the new issue button

story645 self-assigned this Aug 3, 2020

jklymak reviewed Aug 4, 2020

View reviewed changes

ianhi added 2 commits August 3, 2020 23:55

tighten language

e4f58f4

create documentation and enhancment templates

7af95ab

use existing issue label

b75555d

story645 approved these changes Aug 4, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/documentation.md Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/enhancement.md Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/feature_request.md Show resolved Hide resolved

add more examples + remove enhancement codesnippet

47927a9

Co-Authored-By: hannah <story645@users.noreply.github.com>

QuLogic changed the title ~~add feature request template~~ Add more specific GitHub issue templates Aug 5, 2020

clarify maintenance template and create question template

1f89ebf

QuLogic reviewed Aug 11, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/questions.md Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved

.github/ISSUE_TEMPLATE/maintenance.md Outdated Show resolved Hide resolved

story645 reviewed Aug 11, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/questions.md Show resolved Hide resolved

correct labels of issue templates

d9aee8e

case sensitivity. Also put discourse link before SO to prioritize it.

QuLogic approved these changes Aug 12, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/documentation.md Outdated Show resolved Hide resolved

remove period for consistency + remove extraneous line

033fefe

I belive that the line at the top would have stopped github from picking this up as a valid template.

story645 reviewed Aug 12, 2020

View reviewed changes

story645 approved these changes Aug 13, 2020

View reviewed changes

story645 merged commit 1d99132 into matplotlib:master Aug 13, 2020

QuLogic added this to the v3.4.0 milestone Aug 13, 2020

ianhi mentioned this pull request Aug 14, 2020

Expand the explanation of the Object-Oriented interface #18249

Closed

QuLogic mentioned this pull request Jan 22, 2021

DOC: tweak issue template #17436

Closed

ianhi mentioned this pull request Feb 7, 2021

add documentation issue template jupyter-widgets/ipywidgets#3095

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more specific GitHub issue templates #18161

Add more specific GitHub issue templates #18161

ianhi commented Aug 3, 2020

story645 commented Aug 3, 2020 •

edited

Loading

jklymak commented Aug 3, 2020

story645 commented Aug 3, 2020

jklymak Aug 4, 2020

jklymak Aug 4, 2020

ianhi Aug 4, 2020

jklymak Aug 4, 2020

ianhi Aug 4, 2020

jklymak Aug 4, 2020

ianhi commented Aug 4, 2020

story645 commented Aug 4, 2020 •

edited

Loading

dopplershift commented Aug 4, 2020

story645 commented Aug 4, 2020

jklymak commented Aug 4, 2020

story645 commented Aug 4, 2020

jklymak commented Aug 4, 2020

story645 commented Aug 4, 2020 •

edited

Loading

jklymak commented Aug 4, 2020

story645 left a comment

ianhi commented Aug 4, 2020 •

edited

Loading

QuLogic commented Aug 5, 2020

story645 commented Aug 5, 2020

ianhi commented Aug 9, 2020 •

edited

Loading

QuLogic commented Aug 10, 2020

QuLogic commented Aug 10, 2020

QuLogic left a comment

ianhi commented Aug 12, 2020

story645 Aug 12, 2020

ianhi Aug 12, 2020

story645 Aug 12, 2020

story645 commented Aug 13, 2020

ianhi commented Aug 13, 2020

		# This template is based on the scikit-learn template
		# https://github.com/scikit-learn/scikit-learn/blob/8e61534f1087703f476414d8dbd3688282f8eebf/.github/ISSUE_TEMPLATE/usage_question.md

Add more specific GitHub issue templates #18161

Add more specific GitHub issue templates #18161

Conversation

ianhi commented Aug 3, 2020

PR Summary

PR Checklist

story645 commented Aug 3, 2020 • edited Loading

jklymak commented Aug 3, 2020

story645 commented Aug 3, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ianhi commented Aug 4, 2020

story645 commented Aug 4, 2020 • edited Loading

dopplershift commented Aug 4, 2020

story645 commented Aug 4, 2020

jklymak commented Aug 4, 2020

story645 commented Aug 4, 2020

jklymak commented Aug 4, 2020

story645 commented Aug 4, 2020 • edited Loading

jklymak commented Aug 4, 2020

story645 left a comment

Choose a reason for hiding this comment

ianhi commented Aug 4, 2020 • edited Loading

QuLogic commented Aug 5, 2020

story645 commented Aug 5, 2020

ianhi commented Aug 9, 2020 • edited Loading

QuLogic commented Aug 10, 2020

QuLogic commented Aug 10, 2020

QuLogic left a comment

Choose a reason for hiding this comment

ianhi commented Aug 12, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

story645 commented Aug 13, 2020

ianhi commented Aug 13, 2020

story645 commented Aug 3, 2020 •

edited

Loading

story645 commented Aug 4, 2020 •

edited

Loading

story645 commented Aug 4, 2020 •

edited

Loading

ianhi commented Aug 4, 2020 •

edited

Loading

ianhi commented Aug 9, 2020 •

edited

Loading