Skip to content

Commit

Permalink
Merge pull request cytopia#885 from cytopia/fix-templates
Browse files Browse the repository at this point in the history
Enhance issue templates
  • Loading branch information
cytopia authored Apr 1, 2022
2 parents 6c2b42c + 14bba0a commit 4fb67be
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 19 deletions.
35 changes: 28 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -113,24 +113,45 @@ 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

- type: textarea
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
Expand All @@ -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
Expand Down
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,3 @@ body:
options:
- "Yes"
- "No"
validations:
required: true
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -27,5 +34,3 @@ body:
options:
- "Yes"
- "No"
validations:
required: true
34 changes: 26 additions & 8 deletions .github/ISSUE_TEMPLATE/howto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- label: I have not done anything yet
validations:
required: true

- type: textarea
attributes:
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 do you want to do?
description: Tell us, what you want to do that you are struggling with
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 the goal?
description: Tell us, what is the goal that you want to accomplish?
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

0 comments on commit 4fb67be

Please sign in to comment.