From 54ce85ac163515bf287b873e2258f80eaa077bc7 Mon Sep 17 00:00:00 2001 From: Andrii Ieroshenko Date: Wed, 3 Jul 2024 18:31:33 -0700 Subject: [PATCH 1/4] add bug, issue, PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 66 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 33 ++++++++++++ .github/pull_request_template.md | 26 +++++++++ 3 files changed, 125 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..83caabba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,66 @@ +--- +name: Bug report +about: Create a report to help us repair something that is currently broken. +title: '' +labels: 'bug' +assignees: '' +--- + + + +## Description + + + +## Reproduce + + + +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error '...' + + + +## Expected behavior + + + +## Context + + + +- Operating System and version: +- Browser and version: +- JupyterLab version: +- Jupyter Scheduler 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 lab` here, use `--debug` if possible.
+
+
+ +
Browser Output + +
+Paste the output from your browser Javascript console here, if applicable.
+
+
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..3aaedd64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature request +about: Suggest a new feature or a change. +title: '' +labels: 'enhancement' +assignees: '' +--- + + + + + +### Problem + + + +### Proposed Solution + + + +### Additional context + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..91dcdee3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ + + +## References + + + + + +## Code changes + + + +## User-facing changes + + + + + +## Backwards-incompatible changes + + From c8372981804eb59746cf6df36f2dd95eea5ff444 Mon Sep 17 00:00:00 2001 From: Andrii Ieroshenko Date: Mon, 8 Jul 2024 09:47:26 -0700 Subject: [PATCH 2/4] Improve text based on suggestions --- .github/ISSUE_TEMPLATE/feature_request.md | 3 ++- .github/pull_request_template.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 3aaedd64..5c986683 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -10,7 +10,8 @@ assignees: '' ### Problem diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 91dcdee3..a3fd63f5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,7 +7,7 @@ https://jupyter-scheduler.readthedocs.io/en/latest/contributors/index.html ## References - + From e0b106c05f5ee203ba027062fddcf1b5188e4da8 Mon Sep 17 00:00:00 2001 From: Andrii Ieroshenko Date: Mon, 8 Jul 2024 10:28:27 -0700 Subject: [PATCH 3/4] Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 83caabba..18c3acbe 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,7 +17,7 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html -## Reproduce +## How to reproduce From 6b162d5fae64a85911a0fb8a684b4529d2afd064 Mon Sep 17 00:00:00 2001 From: Andrii Ieroshenko Date: Mon, 8 Jul 2024 10:28:39 -0700 Subject: [PATCH 4/4] Update .github/ISSUE_TEMPLATE/feature_request.md Co-authored-by: Jason Weill <93281816+JasonWeill@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5c986683..2586e356 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -21,7 +21,7 @@ https://github.com/jupyter-server/jupyter-scheduler/issues * I would like it if [...] happened when I [...] because [...] --> -### Proposed Solution +### Proposed solution