From 2cb63e023bd5caaf960b0ef1ae33ba8501e46962 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Thu, 3 Apr 2025 15:55:06 +0200 Subject: [PATCH 1/6] add templates --- .github/DISCUSSION_TEMPLATE/general.yml | 16 ++++ .github/DISCUSSION_TEMPLATE/ideas.yml | 21 +++++ .github/DISCUSSION_TEMPLATE/q-a.yml | 35 ++++++++ .github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml | 81 +++++++++++++++++++ .../ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml | 40 +++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 36 --------- .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ---- .github/workflows/comment_fr.yml | 37 +++++++++ .github/workflows/stale_issues.yml | 45 +++++++++++ 10 files changed, 283 insertions(+), 53 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/general.yml create mode 100644 .github/DISCUSSION_TEMPLATE/ideas.yml create mode 100644 .github/DISCUSSION_TEMPLATE/q-a.yml create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/comment_fr.yml create mode 100644 .github/workflows/stale_issues.yml diff --git a/.github/DISCUSSION_TEMPLATE/general.yml b/.github/DISCUSSION_TEMPLATE/general.yml new file mode 100644 index 000000000..53532e673 --- /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/cotes2020/jekyll-theme-chirpy/blob/master/docs/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..173252931 --- /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](). + 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..0c9213c90 --- /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/testing-gh-templates). + - 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..81dd18c3f --- /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/testing-gh-templates). + - 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. diff --git a/.github/workflows/comment_fr.yml b/.github/workflows/comment_fr.yml new file mode 100644 index 000000000..21c2e59d3 --- /dev/null +++ b/.github/workflows/comment_fr.yml @@ -0,0 +1,37 @@ +name: Add Comment to Feature Issues +on: + issues: + types: [opened] + +jobs: + add-comment: + # Only run if the added label is "feature" + if: github.event.label.name == 'feature' + runs-on: ubuntu-latest + permissions: + issues: write + + steps: + - name: Add comment + uses: actions/github-script@v7 + with: + script: | + const issueNumber = context.issue.number; + const owner = context.repo.owner; + const repo = context.repo.repo; + + const message = `Thank you for submitting this feature request! 🚀 + + We will review this request and evaluate it soon. + We'll update this issue as we make progress. + + In the meantime, please provide any additional context or use cases that might help us better understand the feature request. + + Want to show your support for this feature? Give a thumbs up reaction (👍) on the original post above!`; + + await github.rest.issues.createComment({ + owner: owner, + repo: repo, + issue_number: issueNumber, + body: message + }); diff --git a/.github/workflows/stale_issues.yml b/.github/workflows/stale_issues.yml new file mode 100644 index 000000000..99704c7f9 --- /dev/null +++ b/.github/workflows/stale_issues.yml @@ -0,0 +1,45 @@ +name: Close Stale Issues + +on: + # Runs daily at 10:00 AM UTC + schedule: + - cron: '0 10 * * *' + # Runs at issue comment + issue_comment: + types: [created] + + # Allow manual trigger + workflow_dispatch: + +jobs: + manage-stale-issues: + runs-on: ubuntu-latest + + steps: + - name: Close Stale Issues + uses: actions/stale@v9 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + + # Issue-specific configuration + stale-issue-message: > + 👋 This issue has been automatically marked as stale due to inactivity. + If this issue is still relevant, please comment to keep it open. + Without activity, it will be closed in 7 days. + + close-issue-message: > + 🔒 This issue has been automatically closed due to prolonged inactivity. + Feel free to reopen if the issue is still valid. + + # More nuanced staleness criteria + days-before-issue-stale: 7 # Mark as stale after 7 days of inactivity + days-before-issue-close: 7 # Close 7 days after being marked stale + + # More specific labeling + stale-issue-label: ':grey_question: no-issue-activity' + close-issue-label: ':lock: closed-no-issue-activity' + + # Refined issue selection, Only issues with both bug and question label + only-issue-labels: ':bug: bug, :question: question' + +# Issues will be closed as "Not Planned" by default. From 782e18aa097d0656dee3b67b3f2c8f2c76669419 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Sun, 6 Apr 2025 13:52:42 +0200 Subject: [PATCH 2/6] Update general.yml --- .github/DISCUSSION_TEMPLATE/general.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/general.yml b/.github/DISCUSSION_TEMPLATE/general.yml index 53532e673..c1af502a6 100644 --- a/.github/DISCUSSION_TEMPLATE/general.yml +++ b/.github/DISCUSSION_TEMPLATE/general.yml @@ -6,7 +6,7 @@ body: options: - label: >- I have read and accepted the - [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md). + [contributing guidelines](https://github.com/alexjustesen/speedtest-tracker/blob/main/CONTRIBUTING.md). required: true - type: textarea attributes: From 1c8932f4b19e4ed323ec23282c56975d9744b651 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Sun, 6 Apr 2025 13:53:34 +0200 Subject: [PATCH 3/6] Update q-a.yml --- .github/DISCUSSION_TEMPLATE/q-a.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml index 173252931..030635e80 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yml +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -5,7 +5,7 @@ body: 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](). + - 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 From dc23352e36413a0a38e08bd3a99ad8a6492189e2 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Mon, 14 Apr 2025 12:56:04 +0200 Subject: [PATCH 4/6] Update BUG_REPORT_FORM.yml --- .github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml index 0c9213c90..8ec76f3b6 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml @@ -6,7 +6,7 @@ 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/testing-gh-templates). + 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 From ce90684c9daa139569fc9937df45458de7462e9d Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Mon, 14 Apr 2025 12:58:07 +0200 Subject: [PATCH 5/6] Fix links --- .github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml index 81dd18c3f..e311293ef 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml @@ -6,7 +6,7 @@ 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/testing-gh-templates). + 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 From b9fbbc4238e18158c817278486e8ed6fda21fc64 Mon Sep 17 00:00:00 2001 From: Sven van Ginkel Date: Mon, 14 Apr 2025 14:47:38 +0200 Subject: [PATCH 6/6] add templates --- .github/workflows/comment_fr.yml | 37 ------------------------ .github/workflows/stale_issues.yml | 45 ------------------------------ 2 files changed, 82 deletions(-) delete mode 100644 .github/workflows/comment_fr.yml delete mode 100644 .github/workflows/stale_issues.yml diff --git a/.github/workflows/comment_fr.yml b/.github/workflows/comment_fr.yml deleted file mode 100644 index 21c2e59d3..000000000 --- a/.github/workflows/comment_fr.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: Add Comment to Feature Issues -on: - issues: - types: [opened] - -jobs: - add-comment: - # Only run if the added label is "feature" - if: github.event.label.name == 'feature' - runs-on: ubuntu-latest - permissions: - issues: write - - steps: - - name: Add comment - uses: actions/github-script@v7 - with: - script: | - const issueNumber = context.issue.number; - const owner = context.repo.owner; - const repo = context.repo.repo; - - const message = `Thank you for submitting this feature request! 🚀 - - We will review this request and evaluate it soon. - We'll update this issue as we make progress. - - In the meantime, please provide any additional context or use cases that might help us better understand the feature request. - - Want to show your support for this feature? Give a thumbs up reaction (👍) on the original post above!`; - - await github.rest.issues.createComment({ - owner: owner, - repo: repo, - issue_number: issueNumber, - body: message - }); diff --git a/.github/workflows/stale_issues.yml b/.github/workflows/stale_issues.yml deleted file mode 100644 index 99704c7f9..000000000 --- a/.github/workflows/stale_issues.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Close Stale Issues - -on: - # Runs daily at 10:00 AM UTC - schedule: - - cron: '0 10 * * *' - # Runs at issue comment - issue_comment: - types: [created] - - # Allow manual trigger - workflow_dispatch: - -jobs: - manage-stale-issues: - runs-on: ubuntu-latest - - steps: - - name: Close Stale Issues - uses: actions/stale@v9 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - - # Issue-specific configuration - stale-issue-message: > - 👋 This issue has been automatically marked as stale due to inactivity. - If this issue is still relevant, please comment to keep it open. - Without activity, it will be closed in 7 days. - - close-issue-message: > - 🔒 This issue has been automatically closed due to prolonged inactivity. - Feel free to reopen if the issue is still valid. - - # More nuanced staleness criteria - days-before-issue-stale: 7 # Mark as stale after 7 days of inactivity - days-before-issue-close: 7 # Close 7 days after being marked stale - - # More specific labeling - stale-issue-label: ':grey_question: no-issue-activity' - close-issue-label: ':lock: closed-no-issue-activity' - - # Refined issue selection, Only issues with both bug and question label - only-issue-labels: ':bug: bug, :question: question' - -# Issues will be closed as "Not Planned" by default.