From 14bba0a14015108a30d8f85bf1eb957688c5079e Mon Sep 17 00:00:00 2001 From: cytopia Date: Fri, 1 Apr 2022 05:47:58 +0200 Subject: [PATCH] Enhance issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 35 +++++++++++++++---- .github/ISSUE_TEMPLATE/documentation.yml | 2 -- .github/ISSUE_TEMPLATE/feature_request.yml | 9 +++-- .github/ISSUE_TEMPLATE/howto.yml | 40 ++++++++++++++++------ 4 files changed, 64 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5c6e1f32..b5f4d599 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -18,8 +18,8 @@ body: label: Have you already looked into this bug? description: Please invest some time and check if this bug is already mentioned or documented elsewhere (You may select more than one). options: - - label: I have read the [Troubleshooting Guide](https://devilbox.readthedocs.io/en/latest/support/troubleshooting.html) - - label: I have checked the [Devilbox forum](https://devilbox.discourse.group/) + - label: I have checked the [Troubleshooting Guide](https://devilbox.readthedocs.io/en/latest/support/troubleshooting.html) + - label: I have checked the [Devilbox Forum](https://devilbox.discourse.group/) - label: I have googled this bug already with no luck - label: I have checked [existing issues](https://github.com/cytopia/devilbox/issues) for similar bugs - label: I have checked [Release notes](https://github.com/cytopia/devilbox/releases) @@ -113,11 +113,32 @@ body: validations: required: true + - type: dropdown + attributes: + label: Have you removed stopped containers before starting? + description: "Have you done a `docker-compose rm` before starting up the Devilbox? [More info here](https://docs.docker.com/compose/reference/rm/)" + multiple: false + options: + - "Yes" + - "No" + validations: + required: true + + - type: dropdown + attributes: + label: Have you pulled latest Docker images before starting? + description: "Have you done a `docker-compose pull` before starting up the Devilbox?" + multiple: false + options: + - "Yes" + - "No" + validations: + required: true + - type: input - id: devilbox-start-command attributes: label: Devilbox start command - description: "What is the command you have used to start the Devilbox?" + description: "What is the [start command](https://devilbox.readthedocs.io/en/latest/getting-started/start-the-devilbox.html) you have used to start the Devilbox?" validations: required: true @@ -125,12 +146,12 @@ body: id: log-env-file attributes: label: "Log: .env file" - description: "Please copy and paste your `.env` file into this text aread" + description: "Please copy and paste your `.env` file into this text area" - type: textarea id: log-docker-compose attributes: label: "Log: docker-compose logs" - description: "Please copy and paste the output of `docker-compose logs` into this text aread" + description: "Please copy and paste the output of `docker-compose logs` into this text area" render: shell validations: required: true @@ -139,7 +160,7 @@ body: id: log-check-config attributes: label: "Log: ./check-config.sh" - description: "Please copy and paste the output of `./check-config.sh` into this text aread" + description: "Please copy and paste the output of `./check-config.sh` into this text area" render: shell validations: required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 3f16a57f..5f7e7331 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -28,5 +28,3 @@ body: options: - "Yes" - "No" - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 1f143112..14a6e306 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -14,6 +14,13 @@ body: validations: required: true + - type: textarea + attributes: + label: Benefits + description: Tell us, how this this will be beneficial to the Devilbox. + validations: + required: false + - type: textarea attributes: label: Where can we find information about this? @@ -27,5 +34,3 @@ body: options: - "Yes" - "No" - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/howto.yml b/.github/ISSUE_TEMPLATE/howto.yml index 890a0043..251b6668 100644 --- a/.github/ISSUE_TEMPLATE/howto.yml +++ b/.github/ISSUE_TEMPLATE/howto.yml @@ -3,30 +3,48 @@ name: "❔ How to do ...?" description: How do I do X or Y with the Devilbox? title: "[Howto]: " labels: ["question", "Community help wanted"] -assignees: - - cytopia +assignees: [] body: + - type: markdown + attributes: + value: | + If this is a generic question, please consider using the [Devilbox forum](https://devilbox.discourse.group/) instead. + - type: checkboxes attributes: label: Have you already checked elsewhere? description: You may select more than one. options: - - label: I have checked the [Devilbox forum](https://devilbox.discourse.group/) - - label: I have checked the [Devilbox documentation](https://devilbox.readthedocs.io/en/latest/) + - label: I have read the [Devilbox documentation](https://devilbox.readthedocs.io/en/latest/) + - label: I have checked the [Devilbox Troubleshooting Guide](https://devilbox.readthedocs.io/en/latest/) + - label: I have checked the [Devilbox FAQ](https://devilbox.readthedocs.io/en/latest/support/faq.html) + - label: I have checked the [Devilbox Howto](https://devilbox.readthedocs.io/en/latest/support/howto.html) + - label: I have checked the [Devilbox Forum](https://devilbox.discourse.group/) + - label: I have checked [existing issues](https://github.com/cytopia/devilbox/issues) - label: I have googled already with no luck - - - type: textarea - attributes: - label: What do you want to do? - description: Tell us, what you want to do that you are struggling with + - label: I have not done anything yet validations: required: true - type: textarea attributes: - label: What is the goal? - description: Tell us, what is the goal that you want to accomplish? + label: What are you struggling with? + description: Tell the community, what you are struggling with. Be as specific as possible to make it easier for other people to answer your question. + validations: + required: true + + - type: textarea + attributes: + label: What have you tried already? + description: Add some details on what you have tried already, so this can be ruled out. + validations: + required: true + + - type: textarea + attributes: + label: What is your goal? + description: Tell the community, what you want to accomplish? This might be helpful to know in order to prevent [XY problems](https://en.wikipedia.org/wiki/XY_problem). validations: required: true