Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a430bf2

Browse filesBrowse files
authored
Merge pull request #7701 from petehuang/bug-report-req
DOC: Add bug report reqs and template to contributing guide
2 parents db685c7 + c63f401 commit a430bf2
Copy full SHA for a430bf2

File tree

Expand file treeCollapse file tree

2 files changed

+64
-9
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+64
-9
lines changed

‎.github/ISSUE_TEMPLATE.md

Copy file name to clipboard
+35-7Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
11
To help us understand and resolve your issue please check that you have provided
2-
the information below.
2+
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.
3+
4+
###Bug report
5+
6+
**Bug summary**
7+
8+
- [ ] A short 1-2 sentences that succinctly describes the bug
9+
10+
**Code for reproduction**
11+
12+
- [ ] A minimum code snippet required to reproduce the bug, also minimizing the number of dependencies required
13+
14+
```python
15+
# Paste your code here
16+
#
17+
#
18+
```
19+
20+
**Actual outcome**
21+
22+
- [ ] The output produced by the above code, which may be a screenshot, console output, etc.
23+
24+
```
25+
# If applicable, paste the console output here
26+
#
27+
#
28+
```
29+
30+
**Expected outcome**
31+
32+
- [ ] A description of the expected outcome from the code snippet
33+
- [ ] If this used to work in an earlier version of Matplotlib, please note the version it used to work on
34+
35+
**Matplotlib version**
336

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

‎doc/devel/contributing.rst

Copy file name to clipboardExpand all lines: doc/devel/contributing.rst
+29-2Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,36 @@ Submitting a bug report
1414

1515
If you find a bug in the code or documentation, do not hesitate to submit a
1616
ticket to the
17-
`Bug Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are
18-
also welcome to post feature requests or pull requests.
17+
`Bug Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are also
18+
welcome to post feature requests or pull requests.
1919

20+
If you are reporting a bug, please do your best to include the following:
21+
22+
1. A short, top-level summary of the bug. In most cases, this should be 1-2
23+
sentences.
24+
25+
2. A short, self-contained code snippet to reproduce the bug, ideally allowing
26+
a simple copy and paste to reproduce. Please do your best to reduce the code
27+
snippet to the minimum required.
28+
29+
3. The actual outcome of the code snippet
30+
31+
4. The expected outcome of the code snippet
32+
33+
5. The Matplotlib version, Python version and platform that you are using. You
34+
can grab the version with the following commands::
35+
36+
>>> import matplotlib
37+
>>> matplotlib.__version__
38+
'1.5.3'
39+
>>> import platform
40+
>>> platform.python_version()
41+
'2.7.12'
42+
43+
We have preloaded the issue creation page with a Markdown template that you can
44+
use to organize this information.
45+
46+
Thank you for your help in keeping bug reports complete, targeted and descriptive.
2047

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

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.