From a10441e3198c6e4e30e9f257f06893356066841d Mon Sep 17 00:00:00 2001 From: Jocelyn Le Sage Date: Tue, 9 May 2023 17:31:58 -0400 Subject: [PATCH] Added GitHub issue templates. --- .github/ISSUE_TEMPLATE/bug-report.yml | 93 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 16 ++++ 3 files changed, 117 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..980fcd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,93 @@ +name: Bug report +description: File a bug report. +title: "[Bug] Provide a short description of the bug here" +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + validations: + required: false + - type: textarea + attributes: + label: Environment + description: | + Provide details about the host running the container. + Examples: + - Operating system (e.g. Ubuntu, Windows, TrueNAS, openmediavault, unRAID, etc). + - Version of the operating system. + - CPU architecture (x86-64, arm, arm64, etc). + - Model of the device, if applicable (e.g. Raspberry Pi 4B, Synology DS418, QNAP TS-364, etc). + - The Docker version (output of `docker version`). + - Anything else specific to your environment. Examples: + - Network share (NFS, CIFS) mapped to the container. + - Docker running in LXC container. + - etc. + - If applicable, how the UI provided by the container is access: + - Browser (Chrome, Firefox, Edge, etc). + - Version of the browser. + - OS of the browser. + - Is the container accessed through a reverse proxy. + - etc. + value: | + - OS: + - OS version: + - CPU: + - Docker version: + - Device model: + - Browser/OS: + validations: + required: false + - type: textarea + attributes: + label: Container creation + description: | + How did you create the container ? + Examples: + - The `docker run` command used. + - The compose file used. + - Screenshots of the management tool UI (e.g. Portainer, unRAID, etc) showing container settings. + validations: + required: true + - type: textarea + attributes: + label: Container log + description: Please copy/paste the output of `docker logs `. + render: text + validations: + required: true + - type: textarea + attributes: + label: Container inspect + description: | + If the container is running, please provide the output of `docker inspect `. + **Attention**: If you defined passwords, secrets or any sensitive information via environment variables, make sure to remove them from the output. + render: text + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Anything that will give 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 0000000..6101e44 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Ask a question, discuss + url: https://github.com/jlesage/docker-firefox/discussions + about: Get help using this Docker container. + - name: Documentation + url: https://github.com/jlesage/docker-firefox#readme + about: Documentation about this Docker container. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..527b3f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,16 @@ +name: Feature request +description: Suggest an idea for this project. +title: "[Feature request] Provide a short description of the feature here" +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thank you for suggesting an idea to make this project better. + - type: textarea + attributes: + label: Idea + description: | + Please describe the desired behavior, pitch your idea, or suggest improvements. + validations: + required: true