Skip to content

Commit 43511b6

Browse files
andrii-iJasonWeill
andrii-i
and
JasonWeill
authored
Add GitHub bug, issue, PR templates (#534)
* add bug, issue, PR templates * Improve text based on suggestions * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Jason Weill <[email protected]> * Update .github/ISSUE_TEMPLATE/feature_request.md Co-authored-by: Jason Weill <[email protected]> --------- Co-authored-by: Jason Weill <[email protected]>
1 parent 3a5c2ae commit 43511b6

File tree

3 files changed

+126
-0
lines changed

3 files changed

+126
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us repair something that is currently broken.
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
<!-- Welcome! Thank you for contributing. These HTML comments will not render in the issue.
10+
Before creating a new issue:
11+
* Search for relevant issues
12+
* Follow the JupyterLab issue reporting guidelines:
13+
https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
14+
-->
15+
16+
## Description
17+
18+
<!--Describe the bug clearly and concisely. Include screenshots if possible-->
19+
20+
## How to reproduce
21+
22+
<!--Describe step-by-step instructions to reproduce the behavior-->
23+
24+
1. Go to '...'
25+
2. Click on '...'
26+
3. Scroll down to '...'
27+
4. See error '...'
28+
29+
<!--Describe how you diagnosed the issue. See the JupyterLab guidelines at
30+
https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html -->
31+
32+
## Expected behavior
33+
34+
<!--Describe what you expected to happen-->
35+
36+
## Context
37+
38+
<!--Complete the following for context, and add any other relevant context-->
39+
40+
- Operating System and version: <!-- e.g. Linux Ubuntu 21.04 -->
41+
- Browser and version: <!-- e.g. Chrome 92 -->
42+
- JupyterLab version: <!-- e.g. 3.1.7 -->
43+
- Jupyter Scheduler version: <!-- e.g. 2.7.1 -->
44+
45+
<!--The more content you provide, the more we can help!-->
46+
47+
<details><summary>Troubleshoot Output</summary>
48+
<pre>
49+
Paste the output from running `jupyter troubleshoot` from the command line here.
50+
You may want to sanitize the paths in the output.
51+
</pre>
52+
</details>
53+
54+
<details><summary>Command Line Output</summary>
55+
<pre>
56+
Paste the output from your command line running `jupyter lab` here, use `--debug` if possible.
57+
</pre>
58+
</details>
59+
60+
<details><summary>Browser Output</summary>
61+
<!--See https://webmasters.stackexchange.com/a/77337 for how to access the JavaScript console-->
62+
<pre>
63+
Paste the output from your browser Javascript console here, if applicable.
64+
65+
</pre>
66+
</details>

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or a change.
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
<!-- 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! -->
10+
11+
<!--
12+
Thanks for thinking of a way to improve Jupyter Scheduler. 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.
13+
Before creating a new feature request please search the existing issues for relevant feature requests:
14+
https://github.com/jupyter-server/jupyter-scheduler/issues
15+
-->
16+
17+
### Problem
18+
19+
<!-- Provide a clear and concise description of what problem this feature will solve. For example:
20+
* I'm always frustrated when [...] because [...]
21+
* I would like it if [...] happened when I [...] because [...]
22+
-->
23+
24+
### Proposed solution
25+
26+
<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
27+
* Add an option so that when [...] [...] will happen
28+
-->
29+
30+
### Additional context
31+
32+
<!-- 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:
33+
* Another project [...] solved this by [...]
34+
-->

‎.github/pull_request_template.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
Thanks for contributing to Jupyter Scheduler!
3+
Please fill out the following items to submit a pull request.
4+
Please refer to our contributor's guide for more information on installation and usage:
5+
https://jupyter-scheduler.readthedocs.io/en/latest/contributors/index.html
6+
-->
7+
8+
## References
9+
10+
<!-- Note the issue numbers this pull request addresses (should be at least one, see the contributing guidelines above). -->
11+
12+
<!-- Note any other pull requests that address this issue and how this pull request is different. -->
13+
14+
## Code changes
15+
16+
<!-- Describe the code changes and how they address the issue. -->
17+
18+
## User-facing changes
19+
20+
<!-- Describe any visual or user interaction changes and how they address the issue. -->
21+
22+
<!-- For visual changes, include before and after screenshots or GIF/mp4/other video demo here. -->
23+
24+
## Backwards-incompatible changes
25+
26+
<!-- Describe any backwards-incompatible changes to JupyterLab public APIs. -->

0 commit comments

Comments
 (0)