8000 Sync bug report info in contributing.rst with issue template · matplotlib/matplotlib@f6a3178 · GitHub
[go: up one dir, main page]
Skip to content

Commit f6a3178

Browse files
petehuangpetehuang
committed
Sync bug report info in contributing.rst with issue template
1 parent 2db2fad commit f6a3178

File tree

2 files changed

+43
-44
lines changed

2 files changed

+43
-44
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines 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

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ 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 welcome to post feature requests or pull requests.
1918

20-
If you are reporting a bug, please do your best to include each of the following:
19+
If you are reporting a bug, please do your best to include the following:
2120

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

3130
4. The expected outcome of the code snippet
3231

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

3635
>>> import matplotlib
3736
>>> matplotlib.__version__
3837
'1.5.3'
38+
>>> import platform
39+
>>> platform.python_version()
40+
'2.7.12'
3941

40-
If you would like a template to organize this information in the issue, you may paste the following into your issue::
41-
42-
**Bug summary**
43-
44-
A short 1-2 sentences that succinctly describes the bug.
45-
46-
**Code for reproduction**
47-
48-
```python
49-
# Paste your code here
50-
#
51-
#
52-
```
53-
54-
**Actual outcome**
55-
56-
Ideally, a direct paste of the output produced by the above code.
57-
58-
```python
59-
# You can use this if it is a piece of console output
60-
#
61-
#
62-
```
63-
64-
**Expected outcome**
65-
66-
A description of the expected outcome
67-
68-
**Matplotlib version**
69-
70-
1.5.3
42+
We have preloaded the issue creation page with a Markdown template that you can use to organize this information.
7143

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

74-
7546
Retrieving and installing the latest version of the code
7647
========================================================
7748

0 commit comments

Comments
 (0)
0