diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..5c4b6bca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,104 @@ +name: Bug report +description: Create a report to help us improve +title: "BUG - " +labels: ["type:Bug"] + +body: + - type: markdown + attributes: + value: | + Hi! Thanks for using the Jupyter Docker Stacks and taking some time to contribute to this project. + + We'd appreciate it if you could check out the [Troubleshooting common problems](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/troubleshooting.html) section in the documentation. + + Please answer the following sections to help us troubleshoot the problem. + + - type: dropdown + id: docker_images + attributes: + label: What docker image are you using? + description: Select as many images as applicable + multiple: true + options: + - all-spark-notebook + - base-notebook + - datascience-notebook + - minimal-notebook + - pyspark-notebook + - r-notebook + - scipy-notebook + - tensorflow-notebook + validations: + required: true + + - type: input + attributes: + label: OS system you are using + validations: + required: true + + - type: textarea + attributes: + label: What Docker command are you running? + description: | + What complete docker command do you run to launch the container (omitting sensitive values)? + placeholder: | + Example: + `docker run -it --rm -p 8888:8888 jupyter/all-spark-notebook` + validations: + required: true + + - type: textarea + attributes: + label: How to Reproduce + description: Please provide steps to reproduce this bug (once the container is running). + placeholder: | + Example: + 1. Visit <http://localhost:8888> + 2. Start an R notebook + 3. ... + validations: + required: true + + - type: textarea + attributes: + label: command_output + render: sh-session + description: | + Provide the output of the steps above, including the commands + themselves and Docker's output/traceback etc. If you're familiar with + Markdown, this block will have triple backticks added automatically + around it -- you don't have to add them. + + If you want to present output from multiple commands, please present + that as a shell session (commands you run get prefixed with `$ `). + Please also ensure that the "How to reproduce" section contains matching + instructions for reproducing this. + + - type: textarea + attributes: + label: Expected behavior + description: | + A clear and concise description of what you expected to happen. + placeholder: | + Example: ggplot output appears in my notebook. + + - type: textarea + attributes: + label: Actual behavior + description: | + A clear and concise description of what the bug is. + placeholder: | + Example: No output is visible in the notebook and the notebook server log contains messages about ... + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..6f8ec16f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: "💬 Jupyter community Discourse" + url: https://discourse.jupyter.org/ + about: Interact with the rest of the Jupyter community + - name: "📖 Jupyter Docker Stacks documentation" + url: https://jupyter-docker-stacks.readthedocs.io/en/latest/index.html + about: Go to the project's documentation + - name: "🔍 Troubleshooting common problems" + url: https://jupyter-docker-stacks.readthedocs.io/en/latest/using/troubleshooting.html + about: Documentation section on troubleshooting commonly encountered errors + - name: "(maintainers only) Blank issue" + url: https://github.com/jupyter/docker-stacks/issues/new + about: For maintainers only diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 7394fcd6..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "type:Enhancement" -assignees: "" ---- - -Hi! Thanks for using the Jupyter Docker Stacks. - -Please see the [Suggesting a new feature](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/features.html#suggesting-a-new-feature) section in the documentation for our preferred processes. - -**What docker images this feature is applicable to?** - -Example: `jupyter/scipy-notebook` - -**What changes do you propose?** - -Example: Add a package [altair](https://altair-viz.github.io). - -**How does this change will affect users?** - -Example: Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub. -With Altair, you can spend more time understanding your data and its meaning. -Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. -This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..4537afe1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,59 @@ +name: Feature request +description: Suggest a new feature for this project +labels: ["type:Enhancement"] +title: "[ENH]: <title>" + +body: + - type: markdown + attributes: + value: >- + Hi! Thanks for using the Jupyter Docker Stacks and taking some time to contribute to this project. + + We'd appreciate it if you could check out the [Suggesting a new feature](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/features.html#suggesting-a-new-feature) section in the documentation for our preferred processes before submitting a feature request. + + - type: dropdown + id: docker_images + attributes: + label: What docker images is this feature applicable to? + description: Select as many images as applicable + multiple: true + options: + - all-spark-notebook + - base-notebook + - datascience-notebook + - minimal-notebook + - pyspark-notebook + - r-notebook + - scipy-notebook + - tensorflow-notebook + validations: + required: true + + - type: textarea + attributes: + label: What changes are you proposing? + description: >- + Example: + - Add the [altair](https://altair-viz.github.io) package to the image. + validations: + required: true + + - type: textarea + attributes: + label: How does this affect the user? + description: >- + Example: + - Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub. + - With Altair, you can spend more time understanding your data and its meaning. + - Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. + - This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code. + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: >- + Links? References? Anything that will give us more context about the feature you are proposing. + validations: + required: false