Skip to content

Commit eb2b4c6

Browse files
authored
Merge pull request jupyter#5896 from Zsailer/issue_template
Add an issue template and issue landing page.
2 parents 02024f0 + 13bc0d6 commit eb2b4c6

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Is this a bug in Notebook? Open an issue.
3+
about: If you're not sure, feel free to post your question on Jupyter's Discourse channel.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
BEFORE YOU OPEN AN ISSUE, PLEASE READ THIS
12+
13+
Hello! Thank you for using Jupyter Notebook. We're glad you're here.
14+
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.
16+
17+
First, it's important to know that Jupyter Notebook development has moved into a phase of maintenance-only. There are very few people with limited time maintaining this repository. This means, we won't likely accept new features here. Instead, we recommend that you check out JupyterLab (https://github.com/jupyterlab/jupyterlab)—Jupyter's next generation Notebook interface.
18+
19+
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, i.e. links to the offending code, snapshots of the UI issue, code-blocks with your console logs, etc.
20+
21+
If you're having issues installing Jupyter Notebook, or you're having another issue and don't know how to proceed, try the following:
22+
23+
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
24+
25+
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.
26+
-->
27+
28+
**Describe the bug**
29+
A clear and concise description of what the bug is.
30+
31+
**To Reproduce**
32+
Steps to reproduce the behavior:
33+
1. Go to '...'
34+
2. Click on '....'
35+
3. Scroll down to '....'
36+
4. See error
37+
38+
**Expected behavior**
39+
A clear and concise description of what you expected to happen.
40+
41+
**Screenshots**
42+
If applicable, add screenshots to help explain your problem.
43+
44+
**Desktop (please complete the following information):**
45+
- OS: [e.g. iOS]
46+
- Browser [e.g. chrome, safari]
47+
- Version [e.g. 22]
48+
49+
**Additional context**
50+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- 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
5+
about: Before posting an issue here, make sure your issue hasn't already been addressed here.
6+
- name: Do you need support or a question answered? See Jupyter Discourse.
7+
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.
10+
url: https://github.com/jupyterlab/jupyterlab
11+
about: Jupyter Notebook is in a maintenance-only phase. We won't likely accept new features; instead, we recommend you check out JupyterLab for new features and support.

0 commit comments

Comments
 (0)