diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c8464a32203..9d259f8a864 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,12 +1,24 @@ - + +### Issue Report Checklist + +* [ ] Searched the [issues page](https://github.com/spyder-ide/spyder/issues?q=is%3Aissue) for similar reports +* [ ] Read the relevant sections of the [Spyder Troubleshooting Guide](https://github.com/spyder-ide/spyder/wiki/Troubleshooting-Guide-and-FAQ) and followed its advice +* [ ] Reproduced the issue after updating with ``conda update spyder`` (or ``pip``, if not using Anaconda) +* [ ] Could not reproduce inside ``jupyter qtconsole`` (if console-related) +* [ ] Tried basic troubleshooting (if a bug/error) + * [ ] Restarted Spyder + * [ ] Reset preferences with ``spyder --reset`` + * [ ] Reinstalled the latest version of [Anaconda](https://www.anaconda.com/download/) + * [ ] Tried the other applicable steps from the Troubleshooting Guide +* [ ] Completed the **Problem Description**, **Steps to Reproduce** and **Version** sections below -If you don't find anything, please provide a detailed step-by-step description (in English) of the problem and what led up to it below. Issue reports without a clear way to reproduce them will be closed. Thanks! ---> ## Problem Description -### What steps will reproduce the problem? +### What steps reproduce the problem? 1. 2. @@ -25,13 +37,16 @@ PASTE TRACEBACK HERE ``` -## Package Versions +## Versions + -* Spyder: -* Python: -* Qt: -* PyQt: -* Operating System: +* Spyder version: +* Python version: +* Qt version: +* PyQt version: +* Operating System name/version: ### Dependencies + -1. You haven't touched any file in the `spyder/defaults` directory. - - There is *absolutely* no need to touch those files. - - If you want to add new configuration options, please go to - `spyder/config/main.py`. -2. You haven't eliminated unnecessary blank lines or spaces during your work. - That makes our reviewing work harder and it could introduce unnecessary - conflicts with other pull requests. -3. You haven't added new icons to Spyder. Please leave decisions about what - icons to use to us :) +### Pull Request Checklist ----- +* [ ] Read and followed this repo's [Contributing Guidelines](https://github.com/spyder-ide/spyder/blob/master/CONTRIBUTING.md) +* [ ] Based your PR on the latest version of the correct branch (master or 3.x) +* [ ] Followed [PEP8](https://www.python.org/dev/peps/pep-0008/) for code style +* [ ] Ensured your pull request hasn't eliminated unrelated blank lines/spaces, + modified the ``spyder/defaults`` directory, or added new icons/assets +* [ ] Wrote at least one-line docstrings for any new functions +* [ ] Added at least one unit test covering the changes, if at all possible +* [ ] Described your changes and the motivation for them below +* [ ] Noted what issue(s) this pull request resolves, creating one if needed +* [ ] Included a screenshot, if this PR makes any visible changes to the UI -*Note*: You can safely remove this text before submitting your work. + +## Description of Changes + + + + + + +### Issue(s) Resolved + + + + + +Fixes # + + + diff --git a/spyder/app/mainwindow.py b/spyder/app/mainwindow.py index 1f52a16a177..3b7c3cd95c7 100644 --- a/spyder/app/mainwindow.py +++ b/spyder/app/mainwindow.py @@ -141,7 +141,7 @@ # Local utility imports #============================================================================== from spyder import (__version__, __project_url__, __forum_url__, - __trouble_url__, get_versions) + __trouble_url__, __trouble_url_short__, get_versions) from spyder.config.base import (get_conf_path, get_module_data_path, get_module_source_path, STDERR, DEBUG, debug_print, MAC_APP_NAME, get_home_dir, @@ -2409,7 +2409,7 @@ def render_issue(self, description='', traceback=''): revision = versions['revision'] # Store and format the reminder message for the troubleshooting guide - reminder_message = ( + reminder_message_full = ( "" ).format(__trouble_url__) + reminder_message_short = ( + "" + ) + + bug_checklist = ( + "* [ ] Searched issues page for similar reports\n" + "* [ ] Read and followed relevant sections of the" + "[Troubleshooting Guide]({0!s})\n" + "* [ ] Reproduced after updating (`conda update spyder`)\n" + "* [ ] Tried basic troubleshooting\n" + " * [ ] Restarted Spyder\n" + " * [ ] Ran `spyder --reset`\n" + " * [ ] Reinstalled latest Anaconda\n" + ).format(__trouble_url_short__) + # Make a description header in case no description is supplied if not description: - description = "### What steps will reproduce the problem?" + description = "### What steps reproduce the problem?" - # Make error section from traceback + # Make error section from traceback and add appropriate reminder header if traceback: error_section = ("### Traceback\n" "```python-traceback\n" "{}\n" "```".format(traceback)) + reminder_message = reminder_message_full else: error_section = '' + reminder_message = reminder_message_short + "\n\n" + bug_checklist issue_template = """\ {reminder_message} -## Problem Description +## Description {description} {error_section} -## Package Versions +## Versions * Spyder version: {spyder_version} {commit} * Python version: {python_version} * Qt version: {qt_version} * {qt_api_name} version: {qt_api_version} -* Operating system: {os_name} {os_version} +* Operating System: {os_name} {os_version} ### Dependencies @@ -2496,13 +2514,13 @@ def report_issue(self, body=None, title=None): @Slot() def trouble_guide(self): - """Open Spyder troubleshooting guide in a web browser""" + """Open Spyder troubleshooting guide in a web browser.""" url = QUrl(__trouble_url__) QDesktopServices.openUrl(url) @Slot() def google_group(self): - """Open Spyder troubleshooting guide in a web browser""" + """Open Spyder troubleshooting guide in a web browser.""" url = QUrl(__forum_url__) QDesktopServices.openUrl(url)