DOC: Add bug report reqs and template to contributing guide#7701
DOC: Add bug report reqs and template to contributing guide#7701tacaswell merged 3 commits intomatplotlib:masterfrom petehuang:bug-report-req
Conversation
|
I'm 50%-50% on this patch: it duplicates a lot of elements which we already have on our ticket page: https://github.com/matplotlib/matplotlib/issues/new Could we have all of this in a single place? In terms of content, it looks good to me. |
|
Oops, wasn't aware of the pre-loaded template on the new issue page. Let's definitely sync from both ends. Is there any place that template can be changed? |
|
You can find it here |
doc/devel/contributing.rst
Outdated
|
|
||
| 4. The expected outcome of the code snippet | ||
|
|
||
| 5. The matplotlib version, python version and platform that you are using. You can grab the |
There was a problem hiding this comment.
@efiring @tacaswell So should matplotlib be capitalized here?
doc/devel/contributing.rst
Outdated
|
|
||
| Thank you for your help in keeping bug reports complete, targeted and descriptive. | ||
|
|
||
| Submitting a feature request |
There was a problem hiding this comment.
I'd remove this section. I don't think it is very useful and has a lot of duplication with the previous section. I think we need to keep the contributing guideline short.
doc/devel/contributing.rst
Outdated
| ticket to the | ||
| `Bug Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are | ||
| also welcome to post feature requests or pull requests. | ||
| `Bug Tracker <https://github.com/matplotlib/matplotlib/issues>`_. |
There was a problem hiding this comment.
I would add back the sentence "You are also welcome to post feature requests or pull requests" here, and remove the section down of details about the feature requests.
.github/ISSUE_TEMPLATE.md
Outdated
| **Expected outcome** | ||
|
|
||
| - [ ] A description of the expected outcome from the code snippet | ||
| - [ ] If this used to work in an earlier version of Matplotlib, please note where it used to work |
There was a problem hiding this comment.
"please note the version it used to work on?"
.github/ISSUE_TEMPLATE.md
Outdated
| - [ ] If this is a regression (Used to work in an earlier version of Matplotlib), please | ||
| note where it used to work. | ||
|
|
||
| ###Feature request |
There was a problem hiding this comment.
I'd remove this section. We want to keep this as simple and short as possible.
|
On 2016/12/30 9:29 PM, Nelle Varoquaux wrote:
+ 5. The matplotlib version, python version and platform that you are using. You can grab the
@efiring <https://github.com/efiring> @tacaswell
<https://github.com/tacaswell> So should matplotlib be capitalized here?
I would say "yes", but this is one of those places where it is perfectly
acceptable to me either way.
|
doc/devel/contributing.rst
Outdated
| ticket to the | ||
| `Bug Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are | ||
| also welcome to post feature requests or pull requests. | ||
| `Bug Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are also welcome to post feature requests or pull requests. |
NelleV
changed the title
|
LGTM 👍 |
QuLogic
changed the title
5 participants
Hopefully this doesn't conflict with #7699 at all (it shouldn't).
This adds a few recommendations for information to include when submitting bug reports. It also provides a Markdown-formatted template for anyone who wants to neatly organize their information in their issue.