Skip to content

Commit 9b9ab51

Browse files
RRosioRRosio
authored
update issue templates (#6939)
1 parent 7c84112 commit 9b9ab51

File tree

3 files changed

+104
-37
lines changed

3 files changed

+104
-37
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+54-31
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,79 @@
11
---
2-
name: Is this a bug in Notebook? Open an issue.
3-
about:
4-
If you're not sure, feel free to post your question on Jupyter's Discourse
5-
channel.
6-
7-
labels: bug
2+
name: "\U0001F41B Bug report"
3+
about: Create a report to help us repair something that is currently broken
4+
labels: bug, status:Needs Triage
85
---
96

7+
<!-- Welcome! Thank you for contributing. These HTML comments will not render in the issue, but you can delete them once you've read them if you prefer! -->
8+
109
<!--
11-
BEFORE YOU OPEN AN ISSUE, PLEASE READ THIS.
10+
Right now, you're opening an issue to report a bug in Jupyter Notebook.
1211
13-
Hello! Thank you for using Jupyter Notebook. We're glad you're here.
12+
Please answer the following questions for yourself before submitting an issue
13+
- [ ] I checked the documentation and found no answer
14+
- [ ] I checked to make sure that this issue has not already been filed
15+
- [ ] I'm reporting the issue to the correct repository
1416
15-
Right now, you're opening an issue. Before you do, let's make sure this is the right place to post your question/issue.
17+
If you have further questions after reading below, please visit the Jupyter Notebook discourse channel (https://discourse.jupyter.org/) and submit your questions there. There are many more people in the Jupyter community that engage on that channel.
1618
19+
NOTE:
1720
Jupyter Notebook 6.x development is in maintenance-only mode. Bugs found in Notebook 6.x and that don't reproduce in Notebook 7.x may not get fixed.
1821
1922
Work in this repository is focused on Jupyter Notebook 7.x, the former RetroLab project. The code base for Notebook 7.x is very different than Notebook 6.x. If you can, please try reproducing Notebook 6.x bugs with Notebook 7.x using the main branch of this repository.
2023
2124
We recommend that you check out JupyterLab (https://github.com/jupyterlab/jupyterlab), Jupyter's next generation Notebook interface.
2225
2326
Here, we're looking for specific bugs in the Jupyter Notebook codebase. If you think you've identified such a bug, you can continue opening your issue here. We'd appreciate if you include as much detail as possible, such as links to the offending code, snapshots of the UI issue, code blocks with your console logs, etc.
27+
-->
2428

25-
If you're having issues installing Jupyter Notebook, or you're having another issue and don't know how to proceed, try the following:
26-
27-
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
29+
## Description
2830

29-
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.
30-
-->
31+
<!--Describe the bug clearly and concisely. Include screenshots if possible-->
3132

32-
**Describe the bug**
33-
A clear and concise description of what the bug is.
33+
## Reproduce
3434

35-
**To Reproduce**
36-
Steps to reproduce the behavior:
35+
<!--Describe step-by-step instructions to reproduce the behavior-->
3736

3837
1. Go to '...'
39-
1. Click on '....'
40-
1. Scroll down to '....'
41-
1. See error
38+
2. Click on '...'
39+
3. Scroll down to '...'
40+
4. See error '...'
41+
42+
<!--Describe how you diagnosed the issue. See the guidelines at
43+
https://jupyter-notebook.readthedocs.io/en/latest/troubleshooting -->
44+
45+
## Expected behavior
46+
47+
<!--Describe what you expected to happen-->
48+
49+
## Context
50+
51+
<!--Complete the following for context, and add any other relevant context-->
52+
53+
- Operating System and version: <!-- e.g. Linux Ubuntu 21.04 -->
54+
- Browser and version: <!-- e.g. Chrome 92 -->
55+
<!-- Please note the Notebook version you are working with. You can find this in the Help -> About Jupyter Notebook menu option or by running `jupyter --version` from your terminal -->
56+
- Jupyter Notebook version: <!-- e.g. 3.1.7 -->
4257

43-
**Expected behavior**
44-
A clear and concise description of what you expected to happen.
58+
<!--The more content you provide, the more we can help!-->
4559

46-
**Screenshots**
47-
If applicable, add screenshots to help explain your problem.
60+
<details><summary>Troubleshoot Output</summary>
61+
<pre>
62+
Paste the output from running `jupyter troubleshoot` from the command line here.
63+
You may want to sanitize the paths in the output.
64+
</pre>
65+
</details>
4866

49-
**Desktop (please complete the following information):**
67+
<details><summary>Command Line Output</summary>
68+
<pre>
69+
Paste the output from your command line running `jupyter notebook` here, use `--debug` if possible.
70+
</pre>
71+
</details>
5072

51-
- OS: \[e.g. iOS\]
52-
- Browser \[e.g. chrome, safari\]
53-
- Version \[e.g. 22\]
73+
<details><summary>Browser Output</summary>
74+
<!--See https://webmasters.stackexchange.com/a/77337 for how to access the JavaScript console-->
75+
<pre>
76+
Paste the output from your browser Javascript console here, if applicable.
5477

55-
**Additional context**
56-
Add any other context about the problem here.
78+
</pre>
79+
</details>

‎.github/ISSUE_TEMPLATE/config.yml

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
blank_issues_enabled: true
1+
blank_issues_enabled: false
22
contact_links:
33
- name: Is this a common issue? See our Docs.
4-
url: https://jupyter-notebook.readthedocs.io/en/stable/troubleshooting.html#what-to-do-when-things-go-wrong
4+
url: https://jupyter-notebook.readthedocs.io/en/latest/troubleshooting.html#what-to-do-when-things-go-wrong
55
about: Before opening an issue, make sure your issue hasn't already been addressed in the documentation.
6-
- name: Do you need support or a question answered? See Jupyter Discourse.
6+
- name: \U0001F914 Support and all other questions, including if you're not sure what to do.
77
url: https://discourse.jupyter.org/c/notebook/31
8-
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!
9-
- name: Do you have a feature request? See JupyterLab.
8+
about: If you have a question or you're having issues installing Jupyter Notebook, try posting on Discourse.
9+
- name: "\U0001F4AC Chat with the devs"
10+
url: https://app.gitter.im/#/room/#jupyter_notebook:gitter.im
11+
about: Ask short questions about using Jupyter Notebook
12+
- name: 📝 Do you have a feature request that may be applied upstream? See JupyterLab.
1013
url: https://github.com/jupyterlab/jupyterlab
11-
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.
14+
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.

‎.github/ISSUE_TEMPLATE/feature_request.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: "\U0001F680 Feature Request"
3+
about: Suggest a new feature or a change
4+
labels: enhancement, status:Needs Triage
5+
---
6+
7+
<!-- Welcome! These HTML comments will not render in the issue, but you can delete them once you've read them if you prefer! -->
8+
9+
<!--
10+
Thanks for thinking of a way to improve Jupyter Notebook. If this solves a problem for you, then it probably solves that problem for lots of people! So the whole community will benefit from this request.
11+
12+
NOTE: Please note that Jupyter Notebook 6.x development is in maintenance-only mode.
13+
14+
Finally, please answer the following questions for yourself before submitting an issue.
15+
16+
- [ ] I checked to make sure that this issue has not already been filed
17+
- [ ] I'm reporting the issue to the correct repository
18+
19+
-->
20+
21+
### Problem
22+
23+
<!-- Provide a clear and concise description of what problem this feature will solve. For example:
24+
25+
* I'm always frustrated when [...] because [...]
26+
* I would like it if [...] happened when I [...] because [...]
27+
-->
28+
29+
### Proposed Solution
30+
31+
<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
32+
33+
* Add an option so that when [...] [...] will happen
34+
-->
35+
36+
### Additional context
37+
38+
<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
39+
40+
* Another project [...] solved this by [...]
41+
-->

0 commit comments

Comments
 (0)