diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 277dbb05..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Something is not working? Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - - - - -### ISSUE TYPE - - - Bug Report - - - -### Checklist - -* [ ] `.env` file is attached -* [ ] `./check-config.sh` output is added below -* [ ] `docker-compose logs` output is added below -* [ ] `docker-compose.override.yml` is attached (if exists) -* [ ] Custom configs from `cfg/` dir are attached (if exist) -* [ ] I've looked through the docs: https://devilbox.readthedocs.io/en/latest/ -* [ ] I've looked through existing issues: https://github.com/cytopia/devilbox/issues -* [ ] I've read troubleshooting: https://devilbox.readthedocs.io/en/latest/support/troubleshooting.html - - -### OS / ENVIRONMENT - -1. Host operating system and version: -2. (Windows only) Native Docker or Docker Toolbox: -3. Docker version: -4. Docker Compose version: -5. (Linux) Is SELinux enabled?: -6. What git commit hash are you on?: - - -### SUMMARY - - - -### STEPS TO REPRODUCE - - - - -### EXPECTED BEHAVIOUR - - - -### ACTUAL BEHAVIOUR - - - -### OTHER INFORMATION - -#### Start command - -``` -$ docker-compose up... -``` - -#### Outputs - -```bash -$ ./check-config.sh - -<<< REPLACE THIS LINE WITH OUTPUT FROM ABOVE COMMAND >>> -``` - - -```bash -$ docker-compose logs - -<<< REPLACE THIS LINE WITH OUTPUT FROM ABOVE COMMAND >>> -``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..bd282b70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,142 @@ +--- +name: "\U0001F41B Bug report" +description: File a bug report +title: "[Bug]: " +labels: ["bug", "triage"] +assignees: + - cytopia + +body: + + - type: dropdown + id: research + attributes: + label: Did you already look into this bug? + description: Please invest some time and check if this bug is already mentioned or documented elsewhere + multiple: true + options: + - I have read the [Troubleshooting Guide](https://devilbox.readthedocs.io/en/latest/support/troubleshooting.html) + - I have checked the [Devilbox forum](https://devilbox.discourse.group/) + - I have googled this bug + - I have checked existing issues for similar bugs + - I have checked [Release notes](https://github.com/cytopia/devilbox/releases) + - I have not done anything yet + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: What is the bug? + description: What exactly is the bug or what went wrong? + validations: + required: true + + - type: textarea + id: expected-behaviour + attributes: + label: Expected behaviour + description: What did you expect to happen instead? + validations: + required: true + + - type: dropdown + id: host-os + attributes: + label: Host Operating System + description: What operating system are you using? + multiple: false + options: + - Linux + - macOS + - Windows + validations: + required: true + + - type: dropdown + id: host-platform + attributes: + label: Host Platform (amd64, arm64, other) + description: What host platform are you running on? + options: + - amd64 + - arm64 + - other + validations: + required: true + + - type: dropdown + id: host-os-linux + attributes: + label: (Linux only) Is SELinux enabled? + description: When using Linux as your host operating system, check if SELinux is enabled or not + options: + - Yes, SELinux is enabled + - No, SELinux is disabled + - I don't know + - I am not on Linux + validations: + required: true + + - type: input + id: docker-version + attributes: + label: Docker version + description: "What Docker version are you using (`docker --version`)" + validations: + required: true + + - type: input + id: docker-compose-version + attributes: + label: Docker Compose version + description: "What Docker Compose version are you using (`docker-compose --version`)" + validations: + required: true + + - type: input + id: devilbox-version + attributes: + label: Devilbox version + description: "What version of Devilbox are you running (latest master, specific tag, git hash, etc)?" + 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?" + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: How can we reproduce the bug? + description: "How do you trigger this bug? Please walk us through it step by step." + 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" + - 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" + render: shell + validations: + required: true + + - type: textarea + 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" + render: shell + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..c45152f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +--- +blank_issues_enabled: false +contact_links: + - name: Devilbox Community Support + url: https://devilbox.discourse.group/ + about: Please ask and answer questions here. + - name: Devilbox Gitter Chat + url: https://gitter.im/devilbox/Lobby + about: Please ask and answer questions here. + - name: Devilbox documentation + url: https://devilbox.readthedocs.io/ + about: Find the Devilbox documentation here. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index edde3f2c..00000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "\U0001F4DD Documentation" -about: Anything related to the Devilbox documentation -title: '' -labels: documentation -assignees: '' - ---- - - - - -#### ISSUE TYPE - - - Documentation - - - -#### SUMMARY - - - -#### Goal - diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..3f16a57f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,32 @@ +--- +name: "\U0001F4DD Documentation" +description: Something is missing or wrong in the documentation. +title: "[Docs]: " +labels: ["documentation"] +assignees: + - cytopia + +body: + + - type: textarea + attributes: + label: What is wrong in the documentation? + description: Tell us, what is wrong in the documentation? + validations: + required: false + + - type: textarea + attributes: + label: What is missing in the documentation? + description: Tell us, what is missing in the documentation? + validations: + required: false + + - type: dropdown + attributes: + label: Are you willing to provide a PR to address this? + options: + - "Yes" + - "No" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 12333d14..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "✨ Feature request" -about: Suggest an idea for this project -title: '' -labels: feature -assignees: '' - ---- - - - - -#### ISSUE TYPE - - - Feature request - - - -#### SUMMARY - - - -#### Goal - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..1f143112 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +--- +name: "✨ Feature request" +description: Suggest an idea or feature for this project +title: "[Feature]: " +labels: ["feature"] +assignees: [] + +body: + + - type: textarea + attributes: + label: What is your idea or feature suggestion? + description: Tell us, what idea or feature you suggest to be added to the Devilbox. + validations: + required: true + + - type: textarea + attributes: + label: Where can we find information about this? + description: If you are proposing a software or tool, please add relevant links and documentation. + validations: + required: false + + - type: dropdown + attributes: + label: Are you willing to provide a PR to address this? + options: + - "Yes" + - "No" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/howto.yml b/.github/ISSUE_TEMPLATE/howto.yml new file mode 100644 index 00000000..22d0afba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/howto.yml @@ -0,0 +1,32 @@ +--- +name: "\U0001F41B How to do ...?" +description: How do I do X or Y with the Devilbox? +title: "[Howto]: " +labels: ["question"] +assignees: + - cytopia + +body: + + - 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 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 + validations: + required: true + + - type: textarea + attributes: + label: What is the goal? + description: Tell us, what is the goal that you want to accomplish? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index e59788af..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: "❔ Question" -about: 'Consider using the Devilbox Forum instead: https://devilbox.discourse.group/' -title: '' -labels: '' -assignees: '' - ---- - - - - - -#### ISSUE TYPE - - - Question - - - -#### SUMMARY - - - -#### Goal -