diff --git a/.github/DISCUSSION_TEMPLATE/general.yml b/.github/DISCUSSION_TEMPLATE/general.yml new file mode 100644 index 000000000..c1af502a6 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/general.yml @@ -0,0 +1,16 @@ +body: + - type: checkboxes + attributes: + label: Checklist + description: Following the guidelines can make you more likely to get responses. + options: + - label: >- + I have read and accepted the + [contributing guidelines](https://github.com/alexjustesen/speedtest-tracker/blob/main/CONTRIBUTING.md). + required: true + - type: textarea + attributes: + label: Description + description: Please describe in detail what you want to share. + validations: + required: true diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 000000000..951c5f54c --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,21 @@ +body: + - type: dropdown + id: idea-section + attributes: + label: "Which part of the application does your idea belong to?" + description: "Select the section of the application that your idea pertains to." + options: + - "Charts" + - "Notifications" + - "Speedtest" + - "WebGui" + default: 0 + validations: + required: true + - type: textarea + attributes: + label: Description + description: Please describe in detail what you want to share. + validations: + required: true + diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml new file mode 100644 index 000000000..030635e80 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -0,0 +1,35 @@ +body: + - type: checkboxes + attributes: + label: Checklist + description: | + Before opening an Q&A make sure you've checked the resources below first, any Q&A that could have been solved by reading the docs or existing issues will be closed. + options: + - label: I have read the [docs](https://docs.speedtest-tracker.dev/help/faqs). + required: true + - label: I have searched open and closed issues. + required: true + - type: dropdown + id: deployment-environment + attributes: + label: Deployment Environment + description: How did you deploy the application? + options: + - Docker Compose + - Docker Run + - Bare Metal + default: 0 + validations: + required: true + - type: textarea + attributes: + label: Description + description: Please describe your qeustion in detail. + validations: + required: true + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Or logs? Anything that will give us more context about the issue you are encountering! diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml new file mode 100644 index 000000000..8ec76f3b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml @@ -0,0 +1,81 @@ +name: Bug Report +description: Use this template to report a bug or issue. +title: "[Bug]: " +labels: ["bug", "unverified"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! You should only use this form for issues, to request a change or feature use the [feature request form](https://github.com/alexjustesen/speedtest-tracker). + - type: checkboxes + attributes: + label: Pre-work + description: | + Before opening an issue make sure you've checked the resources below first, any issues that could have been solved by reading the docs or existing issues will be closed. + options: + - label: I have read the [docs](https://docs.speedtest-tracker.dev). + required: true + - label: I have searched open and closed issues. + required: true + - label: I agree to follow this project's [Code of Conduct](). + required: true + - type: textarea + id: description + attributes: + label: Description + description: Explain the issue you experienced, please be clear and concise. + placeholder: I went to the coffee pot and it was empty. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: In a perfect world, what should have happened? + placeholder: When I got to the coffee pot, it should have been full. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Describe how to reproduce the issue in repeatable steps. + placeholder: | + 1. Go to the coffee pot. + 2. Make more coffee. + 3. Pour it into a cup. + validations: + required: true + - type: dropdown + id: deployment-environment + attributes: + label: Deployment Environment + description: How did you deploy the application? + options: + - Docker Compose + - Docker Run + - Bare Metal + default: 0 + validations: + required: true + - type: textarea + id: application-information + attributes: + label: Application Information + description: To generate application information run `php artisan about --json` from the application's path. This will be automatically formatted into code, so no need for backticks. + render: json + validations: + required: true + - type: input + id: browsers + attributes: + label: What browser(s) are you seeing the problem on? + placeholder: Chrome, Firefox, Safari, etc. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml new file mode 100644 index 000000000..e311293ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Use this template for requesting a new feature or change. +title: "[Feature]: " +labels: ["feature", "needs-review"] +body: + - type: markdown + attributes: + value: | + You should only use this form to request a change or new feature, to report a bug or issue use the [bug report form](https://github.com/alexjustesen/speedtest-tracker). + - type: checkboxes + attributes: + label: Pre-work + options: + - label: I have searched open and closed feature request to make sure this or similar feature request does not already exist. + required: true + - label: I have reviewed the [milestones](https://github.com/alexjustesen/speedtest-tracker/milestones) to ensure that this feature request, or a similar one, has not already been proposed. + required: true + - label: I agree to follow this project's [Code of Conduct](). + required: true + - type: dropdown + id: idea-section + attributes: + label: Which part of the application does your feature belong to? + description: Select the section of the application that your feature pertains to. + options: + - Charts + - Notifications + - Speedtest + - WebGui + default: 0 + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Describe the solution or feature you'd like, you should also mention if this solves a problem. + placeholder: Be sure to keep it clear and concise. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c5dfdf6dc..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Create a bug report to help me improve something -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Environment (please complete the following information):** - - OS: [e.g. Ubuntu] -- Architecture: [e.g. arm64, amd64] - - Browser [e.g. chrome, safari] - - Version [e.g. v1] - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Logs** -If applicable, check the logs for any error that might of occurred. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..678cea79e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: GitHub Community Support + url: https://github.com/orgs/community/discussions + about: Please ask and answer questions here. + - name: GitHub Security Bug Bounty + url: https://bounty.github.com/ + about: Please report security vulnerabilities here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index df81be2be..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Additional context** -Add any other context or screenshots about the feature request here.