From 2db2fada3d39d16e0d47f0e8437050c3d3c93bdf Mon Sep 17 00:00:00 2001 From: Pete Huang Date: Thu, 29 Dec 2016 07:01:46 -0800 Subject: [PATCH 1/3] Add bug report reqs and template to contributing guide --- doc/devel/contributing.rst | 54 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index 83a6fba2938e..f936446b3ecc 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -17,6 +17,60 @@ ticket to the `Bug Tracker `_. You are also welcome to post feature requests or pull requests. +If you are reporting a bug, please do your best to include each of the following: + + 1. A short, top-level summary of the bug. In most cases, this should be 1-2 + sentences. + + 2. A short, self-contained code snippet to reproduce the bug, ideally allowing + a simple copy and paste to reproduce. Please do your best to reduce the code + snippet to the minimum required. + + 3. The actual outcome of the code snippet + + 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:: + + >>> import matplotlib + >>> matplotlib.__version__ + '1.5.3' + +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 + +Thank you for your help in keeping bug reports complete, targeted and descriptive. + Retrieving and installing the latest version of the code ======================================================== From f6a3178777082c1d2608aef3d89d490a581a58b3 Mon Sep 17 00:00:00 2001 From: Pete Huang Date: Fri, 30 Dec 2016 23:46:06 -0800 Subject: [PATCH 2/3] Sync bug report info in contributing.rst with issue template --- .github/ISSUE_TEMPLATE.md | 42 +++++++++++++++++++++++++++++------ doc/devel/contributing.rst | 45 +++++++------------------------------- 2 files changed, 43 insertions(+), 44 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 98440e26d700..77f231fbb768 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -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 +# +# +``` + +**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. + diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index f936446b3ecc..ea2b7dc2ce1b 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -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 `_. You are -also welcome to post feature requests or pull requests. +`Bug Tracker `_. You are also welcome to post feature requests or pull requests. -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. @@ -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 ======================================================== From c63f40176d739a8114f0c42ef4d6337e091e9961 Mon Sep 17 00:00:00 2001 From: Pete Huang Date: Sat, 31 Dec 2016 19:16:56 -0800 Subject: [PATCH 3/3] Adjust wrap in contributing.rst --- doc/devel/contributing.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index ea2b7dc2ce1b..e9941872a17d 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -14,7 +14,8 @@ 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 `_. You are also welcome to post feature requests or pull requests. +`Bug Tracker `_. You are also +welcome to post feature requests or pull requests. If you are reporting a bug, please do your best to include the following: @@ -29,8 +30,8 @@ If you are reporting a bug, please do your best to include the following: 4. The expected outcome of the code snippet - 5. The Matplotlib version, Python version and platform that you are using. You can grab the - version with the following commands:: + 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__ @@ -39,7 +40,8 @@ If you are reporting a bug, please do your best to include the following: >>> platform.python_version() '2.7.12' -We have preloaded the issue creation page with a Markdown template that you can use to organize this information. +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.