From 9b9ab51c67a083cc0c9cc22854beabea1ecbbfe3 Mon Sep 17 00:00:00 2001 From: Rosio Date: Thu, 22 Jun 2023 00:08:44 -0700 Subject: [PATCH] update issue templates (#6939) --- .github/ISSUE_TEMPLATE/bug_report.md | 85 ++++++++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 15 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 41 +++++++++++ 3 files changed, 104 insertions(+), 37 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1754dcc7e..3d2d656c3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,19 +1,22 @@ --- -name: Is this a bug in Notebook? Open an issue. -about: - If you're not sure, feel free to post your question on Jupyter's Discourse - channel. +name: "\U0001F41B Bug report" +about: Create a report to help us repair something that is currently broken +labels: bug, status:Needs Triage +--- -labels: bug ---- + -If you're having issues installing Jupyter Notebook, or you're having another issue and don't know how to proceed, try the following: +## Description -1. scan the "What to do when things go wrong" (https://jupyter-notebook.readthedocs.io/en/stable/troubleshooting.html#what-to-do-when-things-go-wrong) page in our documentation to see if your question has already been answered + -2. post your question on the Jupyter Notebook discourse channel (https://discourse.jupyter.org/c/notebook/31). There are many more people in the Jupyter community that engage on that channel. - --> +## Reproduce -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: + 1. Go to '...' -1. Click on '....' -1. Scroll down to '....' -1. See error +2. Click on '...' +3. Scroll down to '...' +4. See error '...' -**Expected behavior** -A clear and concise description of what you expected to happen. + -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Expected behavior -**Desktop (please complete the following information):** + -- OS: \[e.g. iOS\] -- Browser \[e.g. chrome, safari\] -- Version \[e.g. 22\] +## Context -**Additional context** -Add any other context about the problem here. + + +- Operating System and version: +- Browser and version: + +- Jupyter Notebook version: + + + +
Troubleshoot Output +
+Paste the output from running `jupyter troubleshoot` from the command line here.
+You may want to sanitize the paths in the output.
+
+
+ +
Command Line Output +
+Paste the output from your command line running `jupyter notebook` here, use `--debug` if possible.
+
+
+ +
Browser Output + +
+Paste the output from your browser Javascript console here, if applicable.
+
+
+
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 17b34444a..16e60c334 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,14 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Is this a common issue? See our Docs. - url: https://jupyter-notebook.readthedocs.io/en/stable/troubleshooting.html#what-to-do-when-things-go-wrong + url: https://jupyter-notebook.readthedocs.io/en/latest/troubleshooting.html#what-to-do-when-things-go-wrong about: Before opening an issue, make sure your issue hasn't already been addressed in the documentation. - - name: Do you need support or a question answered? See Jupyter Discourse. + - name: \U0001F914 Support and all other questions, including if you're not sure what to do. url: https://discourse.jupyter.org/c/notebook/31 - about: If you have a question or you're having issues installing Jupyter Notebook, try posting on Discourse. There are lots of friendly Joyvans there to help! - - name: Do you have a feature request? See JupyterLab. + about: If you have a question or you're having issues installing Jupyter Notebook, try posting on Discourse. + - name: "\U0001F4AC Chat with the devs" + url: https://app.gitter.im/#/room/#jupyter_notebook:gitter.im + about: Ask short questions about using Jupyter Notebook + - name: 📝 Do you have a feature request that may be applied upstream? See JupyterLab. url: https://github.com/jupyterlab/jupyterlab - about: We won't likely accept new features for Jupyter Notebook 6.x. We recommend that you check out JupyterLab for new features and support. + about: We recommend that you cross-referrence JupyterLab for information when requesting new features and support for Notebook 7. We won't likely accept new features for Jupyter Notebook 6.x. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..4904f7223 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,41 @@ +--- +name: "\U0001F680 Feature Request" +about: Suggest a new feature or a change +labels: enhancement, status:Needs Triage +--- + + + + + +### Problem + + + +### Proposed Solution + + + +### Additional context + +