8000 DOC: Add bug report reqs and template to contributing guide by petehuang · Pull Request #7701 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

DOC: Add bug report reqs and template to contributing guide #7701

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 3 commits into from
Jan 2, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

8000
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Sync bug report info in contributing.rst with issue template
  • Loading branch information
petehuang committed Dec 31, 2016
commit f6a3178777082c1d2608aef3d89d490a581a58b3
42 changes: 35 additions & 7 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,39 @@
To help us understand and resolve your issue please check that you have provided
the information below.
the information that corresponds to the type of issue that you are submitting. You can feel free to delete the sections that do not apply to your issue.

###Bug report

**Bug summary**

- [ ] A short 1-2 sentences that succinctly describes the bug

**Code for reproduction**

- [ ] A minimum code snippet required to reproduce the bug, also minimizing the number of dependencies required

```python
# Paste your code here
#
#
```
< 8000 /td>
**Actual outcome**

- [ ] The output produced by the above code, which may be a screenshot, console output, etc.

```
# If applicable, paste the console output here
#
#
```

**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 the version it used to work on

**Matplotlib version**

- [ ] Matplotlib version, Python version and Platform (Windows, OSX, Linux ...)
- [ ] How did you install Matplotlib and Python (pip, anaconda, from source ...)
- [ ] If possible please supply a [Short, Self Contained, Correct, Example](http://sscce.org/)
that demonstrates the issue i.e a small piece of code which reproduces the issue
and can be run with out any other (or as few as possible) external dependencies.
- [ ] If this is an image generation bug attach a screenshot demonstrating the issue.
- [ ] If this is a regression (Used to work in an earlier version of Matplotlib), please
note where it used to work.

45 changes: 8 additions & 37 deletions doc/devel/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ Submitting a bug report

If you find a bug in the code or documentation, do not hesitate to submit a
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.
Copy link
Member

Choose a reason for hiding this comment

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

Wrap at 80 here too.


If you are reporting a bug, please do your best to include each of the following:
If you are reporting a bug, please do your best to include the following:

1. A short, top-level summary of the bug. In most cases, this should be 1-2
sentences.
Expand All @@ -30,48 +29,20 @@ If you are reporting a bug, please do your best to include each of the following

4. The expected outcome of the code snippet

5. The version of matplotlib that you are using. You can grab the version with
the following command::
5. The Matplotlib version, Python version and platform that you are using. You can grab the
version with the following commands::

>>> import matplotlib
>>> matplotlib.__version__
'1.5.3'
>>> import platform
>>> platform.python_version()
'2.7.12'

If you would like a template to organize this information in the issue, you may paste the following into your issue::

**Bug summary**

A short 1-2 sentences that succinctly describes the bug.

**Code for reproduction**

```python
# Paste your code here
#
#
```

**Actual outcome**

Ideally, a direct paste of the output produced by the above code.

```python
# You can use this if it is a piece of console output
#
#
```

**Expected outcome**

A description of the expected outcome

**Matplotlib version**

1.5.3
We have preloaded the issue creation page with a Markdown template that you can use to organize this information.

Thank you for your help in keeping bug reports complete, targeted and descriptive.


Retrieving and installing the latest version of the code
========================================================

Expand Down
0