Skip to content

issue form files #20688

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 4 commits into from
Jul 27, 2021
Merged

issue form files #20688

merged 4 commits into from
Jul 27, 2021

Conversation

story645
Copy link
Member

PR Summary

Started drafting the issue form files. Mostly kept the same fields + content as the templates. Haven't validated them yet/deleted the templates because want to discuss:

  1. which fields are required versus which are optional
  2. if this is actually any better than the templates

Also how do I test that these are correct?

@story645 story645 marked this pull request as draft July 20, 2021 05:21
@jklymak
Copy link
Member

jklymak commented Jul 20, 2021

I guess this forces folks to read the questions. But I've not seen how this works in practice. Can they quickly get to a free-form issue?

@story645
Copy link
Member Author

React mixes the two styles and the textareas are free text https://github.com/facebook/react/issues/new/choose

Also, I learned that I can validate these forms by looking at 'em on github https://github.com/story645/matplotlib/tree/itemplates/.github/ISSUE_TEMPLATE

@story645 story645 added the status: needs comment/discussion needs consensus on next step label Jul 22, 2021
@story645 story645 marked this pull request as ready for review July 22, 2021 18:55
@jklymak
Copy link
Member

jklymak commented Jul 23, 2021

I think it can't hurt to try this. When folks fill out the forms do they have full Github functionality, like they can drag images into them etc?

@story645
Copy link
Member Author

So this is what the textarea field (c/o of the react form) looks like:
image

I'm not sure if we should convert all the issues to forms though, which is why I've left both.

@jklymak
Copy link
Member

jklymak commented Jul 23, 2021

Should we just convert them and try it for a while? Its easy to revert if we get complaints/decide we don't like it. I do like the idea of some mandatory fields, because it saves some time in triage...

@story645
Copy link
Member Author

So I got rid of the *.md files, but which fields do folks think should be mandatory? I picked whatever I thought made sense, but likely missed some and required others nobody else thinks should be mandatory.

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

I think this looks good and we could iterate. Probably should get a second review from someone.

@timhoffm
Copy link
Member

I'd make "Bugs: Backend" optional. It's not relevant for most of the bugs. Users do not necessarily know what a backend is, so it may be confusing.

"Bugs: Code for Reproduction". Shorten the description to
"If possible, please provide a minimum self-contained example."

@QuLogic
Copy link
Member

QuLogic commented Jul 26, 2021

Install source should probably have "Distro (Debian/Fedora/etc.)"

@story645
Copy link
Member Author

Oh, so should I add another option (Linux package manager?) or make it a seperate freeform like the conda package? I ask for the system elsewhere - basically the form won't let me do other (freetext)

@QuLogic
Copy link
Member

QuLogic commented Jul 27, 2021

Just another option, I think. They can always leave a note in the system field or something if that's not good enough.

@QuLogic
Copy link
Member

QuLogic commented Jul 27, 2021

Let's see how it goes.

@QuLogic QuLogic merged commit 2967365 into matplotlib:master Jul 27, 2021
@QuLogic QuLogic added this to the v3.5.0 milestone Jul 27, 2021
@QuLogic QuLogic removed the status: needs comment/discussion needs consensus on next step label Jul 27, 2021
@story645 story645 deleted the itemplates branch July 27, 2021 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants