-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
DOC: tweak issue template #17436
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
DOC: tweak issue template #17436
Conversation
500be1b
to
7b46f1e
Compare
.github/ISSUE_TEMPLATE.md
Outdated
* Other libraries: | ||
|
||
<!--Please tell us how you installed matplotlib and python e.g., from source, pip, conda--> | ||
<!--If you installed from conda, please specify which channel you used if not the default--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need that? IMHO it's irrelevant for the majority of reports. We can always ask if it becomes relevant.
.github/ISSUE_TEMPLATE.md
Outdated
**Code for reproduction** | ||
|
||
<!--A minimum code snippet required to reproduce the bug. | ||
Please make sure to minimize the number of dependencies required, and provide | ||
any necessary plotted data. | ||
Avoid using threads, as Matplotlib is (explicitly) not thread-safe.--> | ||
|
||
Please paste as text, not as a screenshot. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this really happen that often that we have to mention it?
I assume if somebody just wanted to posts a screenshot, the example is not minimal and/or not working anyway. Even if that was copy-pasted we would have to ask for improvement. - Long way of saying, I don't think this will help with better reports/less reviewer burden, so we can as well omit it.
I you really want to it, would it be an option to add it to the previous paragraph?
<!--A minimum code snippet required to reproduce the bug (not as screenshot).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Someone was arguing with me about this on discourse over the weekend.
So as someone who has taken photos of code cause it's been easier, are you sure those are screenshots and not photos? |
- put version information request first in the hope it will get filled out more often - remove the comment about threads as that seems like a niche problem that we can deal with as it comes up - explicitly say no screen shots of code
7b46f1e
to
270e266
Compare
95% sure the case I was talking to was a screen shot (perfectly aligned, no moire pattern). Pushed a commit with more re-wording. |
Issue templates were reworked in #18161; I assume we don't need this. |
PR Summary
out more often
problem that we can deal with as it comes up