From 512fcdfa08db6556c9b96eab397e0553013f6ec9 Mon Sep 17 00:00:00 2001 From: Kroese Date: Wed, 17 Apr 2024 18:04:54 +0200 Subject: [PATCH] docs: Add issue templates (#67) --- .github/ISSUE_TEMPLATE /BUG_REPORT.yml | 47 +++++++++++++++++++++ .github/ISSUE_TEMPLATE /FEATURE_REQUEST.yml | 36 ++++++++++++++++ .github/ISSUE_TEMPLATE /QUESTION.yml | 17 ++++++++ 3 files changed, 100 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE /BUG_REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE /FEATURE_REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE /QUESTION.yml diff --git a/.github/ISSUE_TEMPLATE /BUG_REPORT.yml b/.github/ISSUE_TEMPLATE /BUG_REPORT.yml new file mode 100644 index 0000000..df5c08d --- /dev/null +++ b/.github/ISSUE_TEMPLATE /BUG_REPORT.yml @@ -0,0 +1,47 @@ +name: "\U0001F41E Bug Report" +description: Create a report to help us improve the container +title: "[Bug]: " +labels: ["bug"] +body: + - type: input + id: os + attributes: + label: OS version + description: The Linux distribution and kernel version as shown by `uname -a` + validations: + required: true + - type: input + id: docker + attributes: + label: Docker version + description: The Docker version as shown by `docker -v` + validations: + required: true + - type: textarea + id: summary + attributes: + label: Summary + description: A clear and concise description of what the problem is. + validations: + required: true + - type: textarea + id: compose + attributes: + label: Docker Compose file + description: The Docker Compose file (or otherwise `run` command) of the container + validations: + required: true + - type: textarea + id: log + attributes: + label: Docker log + description: The Docker logfile of the container + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: Screenshots + description: Screenshot of the problem + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE /FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE /FEATURE_REQUEST.yml new file mode 100644 index 0000000..d3b3695 --- /dev/null +++ b/.github/ISSUE_TEMPLATE /FEATURE_REQUEST.yml @@ -0,0 +1,36 @@ +name: "\U0001F680 Feature request" +description: Suggest an idea for improving the container +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Is your proposal related to a problem? + description: | + Provide a clear and concise description of what the problem is. + For example, "I'm always frustrated when..." + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like. + description: | + Provide a clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. + description: | + Let us know about other solutions you've tried or researched. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: | + Is there anything else you can add about the proposal? + You might want to link to related issues here, if you haven't already. diff --git a/.github/ISSUE_TEMPLATE /QUESTION.yml b/.github/ISSUE_TEMPLATE /QUESTION.yml new file mode 100644 index 0000000..a6bed0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE /QUESTION.yml @@ -0,0 +1,17 @@ +name: "? Question" +description: General questions about the container +title: "Question: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Have a question about Windows for Docker? + Please make sure to check the [FAQ](https://github.com/dockur/windows-arm/blob/master/readme.md) first! + - type: textarea + id: question + attributes: + label: Question + description: What's the question you have about the container? + validations: + required: true