From be64408846c512c08b948f7ccd77b9365aa4d67d Mon Sep 17 00:00:00 2001 From: Kroese Date: Thu, 16 May 2024 00:53:55 +0200 Subject: [PATCH] docs: Update issue templates (#499) --- .../{BUG_REPORT.yml => 1-issue.yml} | 14 ++-- .../{FEATURE_REQUEST.yml => 2-feature.yml} | 4 +- .github/ISSUE_TEMPLATE/3-bug.yml | 64 +++++++++++++++++++ .../{QUESTION.yml => 4-question.yml} | 6 +- .github/ISSUE_TEMPLATE/config.yml | 1 + 5 files changed, 76 insertions(+), 13 deletions(-) rename .github/ISSUE_TEMPLATE/{BUG_REPORT.yml => 1-issue.yml} (79%) rename .github/ISSUE_TEMPLATE/{FEATURE_REQUEST.yml => 2-feature.yml} (89%) create mode 100644 .github/ISSUE_TEMPLATE/3-bug.yml rename .github/ISSUE_TEMPLATE/{QUESTION.yml => 4-question.yml} (67%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/1-issue.yml similarity index 79% rename from .github/ISSUE_TEMPLATE/BUG_REPORT.yml rename to .github/ISSUE_TEMPLATE/1-issue.yml index 2c88c38..92e235c 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/1-issue.yml @@ -1,12 +1,10 @@ -name: "\U0001F41E Bug Report" -description: Create a report to help us improve the container -title: "[Bug]: " -labels: ["bug"] +name: "\U0001F6A8 Technical issue" +description: When you're experiencing problems using the container body: - type: checkboxes attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. + label: Is there no existing issue for this? + description: Please search to see if no solution was already provided before. options: - label: I have searched the existing issues required: true @@ -30,8 +28,8 @@ body: id: docker attributes: label: Docker version - description: The version of Docker (as shown by `docker -v`). - placeholder: e.g. Docker version 26.0.1, build d260a54 + description: The version of the Docker engine (as shown by `docker -v`). + placeholder: e.g. 26.0.1 validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/2-feature.yml similarity index 89% rename from .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml rename to .github/ISSUE_TEMPLATE/2-feature.yml index 2e9c7e8..5c4a248 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -5,8 +5,8 @@ labels: ["enhancement"] body: - type: checkboxes attributes: - label: Is there an existing feature request for this? - description: Please search to see if the feature request already exists. + label: Is there no existing feature request for this? + description: Please search to see if the feature was not already requested before. options: - label: I have searched the existing feature requests required: true diff --git a/.github/ISSUE_TEMPLATE/3-bug.yml b/.github/ISSUE_TEMPLATE/3-bug.yml new file mode 100644 index 0000000..ca77c2d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-bug.yml @@ -0,0 +1,64 @@ +name: "\U0001F41E Bug report" +description: Create a report to help us improve the container +title: "[Bug]: " +labels: ["bug"] +body: + - type: checkboxes + attributes: + label: Is there no existing bug report for this? + description: Please search to see if the bug was not already reported before. + options: + - label: I have searched the existing bug reports + required: true + - type: input + id: cpu + attributes: + label: Machine specifications + description: The processor and RAM amount in your machine. + placeholder: e.g. Intel N5105 / 16 GB + validations: + required: true + - type: input + id: os + attributes: + label: Operating system + description: The distribution and kernel version (as shown by `uname -a`). + placeholder: e.g. Ubuntu 24.04 / Kernel 6.8.0-22-generic + validations: + required: true + - type: input + id: docker + attributes: + label: Docker version + description: The version of the Docker engine (as shown by `docker -v`). + placeholder: e.g. 26.0.1 + validations: + required: true + - type: textarea + id: summary + attributes: + label: Description + description: Describe the expected behaviour, the actual behaviour, and the steps to reproduce. + validations: + required: true + - type: textarea + id: compose + attributes: + label: Docker compose + description: The compose file (or otherwise the `docker run` command used). + validations: + required: true + - type: textarea + id: log + attributes: + label: Docker log + description: The logfile of the container (as shown by `docker logs windows`). + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: Screenshots (optional) + description: Screenshots that might help to make the problem more clear. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/4-question.yml similarity index 67% rename from .github/ISSUE_TEMPLATE/QUESTION.yml rename to .github/ISSUE_TEMPLATE/4-question.yml index 28f0b61..9094d6d 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/4-question.yml @@ -1,5 +1,5 @@ -name: "? Question" -description: General questions about the container +name: "\U00002753 General question" +description: Questions about the container not related to an issue title: "[Question]: " labels: ["question"] body: @@ -13,7 +13,7 @@ body: - type: checkboxes attributes: label: Is this a general question and not a technical issue? - description: For technical issues you must use the [bug report](https://github.com/dockur/windows/issues/new?assignees=&labels=bug&projects=&template=BUG_REPORT.yml&title=%5BBug%5D%3A+) form instead. It contains all the right fields (system info, logfiles, etc.) we need in order to be able to help you. + description: For questions related to issues you must use the [technical issue](https://github.com/dockur/windows/issues/new?assignees=&labels=&projects=&template=1-issue.yml) form instead. It contains all the right fields (system info, logfiles, etc.) we need in order to be able to help you. options: - label: I am sure my question is not about a technical issue. required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false