Skip to content

chore: update bug report template with support guidelines #2591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexjustesen merged 5 commits into from
Jan 2, 2026
+84 −32
Merged

chore: update bug report template with support guidelines #2591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4619fb3
Update bug report template with support guidelines
svenvg93 Dec 22, 2025
1ee1de7
Merge branch 'main' into Update-issue-template
svenvg93 Dec 26, 2025
fc3a8b7
Merge branch 'alexjustesen:main' into Update-issue-template
svenvg93 Dec 28, 2025
b9b4f86
update templates
svenvg93 Jan 2, 2026
acb506a
Merge branch 'main' into Update-issue-template
alexjustesen Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 58 additions & 21 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,100 @@ name: Bug Report
description: Use this template to report a bug or issue.
title: "[Question] "
labels: ["question", "needs review"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this issue! We appreciate your help in improving the project. If this report is confirmed as a bug, we’ll update its type accordingly.

Please note:
- For **feature requests or changes**, use the [feature request form](https://github.com/alexjustesen/speedtest-tracker/issues/new?template=feature_request.yml).
- For **general questions**, **setup or configuration help**, or if you’re not sure this is a bug, please use **[GitHub Discussions](https://github.com/alexjustesen/speedtest-tracker/discussions)** instead.
- Any isseus with translations should be reported/solved within the [crowdin project](https://crowdin.com/project/speedtest-tracker).
body:
- type: checkboxes
id: terms
attributes:
label: Pre-work
label: Welcome!
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.
The issue tracker is for reporting bugs and feature requests only. For end-user related support questions, please use the **[GitHub Discussions](https://github.com/alexjustesen/speedtest-tracker/discussions)** instead

Please note:
- For translation-related issues or requests, please use the [Crowdin project](https://crowdin.com/project/speedtest-tracker).
- Any issues that can be resolved by consulting the documentation or by reviewing existing open or closed issues will be closed.
- We only support installations that follow the methods described in the documentation. Installations using third-party or undocumented methods are not supported by the project.

options:
- label: I have read the [docs](https://docs.speedtest-tracker.dev).
- label: I have read the [documentation](https://docs.speedtest-tracker.dev) and my problem was not listed in the help section.
required: true
- label: I have searched open and closed issues and my problem was not mentioned before.
required: true
- label: I have searched open and closed issues.
- label: I have verified I am using the latest version available. You can check the latest release [here](https://github.com/alexjustesen/speedtest-tracker/releases).
required: true
- label: I agree to follow this project's [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md).
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.
label: What did you do?
description: |
How to write a good bug report?

- Respect the issue template as much as possible.
- The title should be short and descriptive.
- Explain the conditions which led you to report this issue: the context.
- The context should lead to something, a problem that you’re facing.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: In a perfect world, what should have happened?
description: |
In a perfect world, what should have happened?
**Important:** Be specific. Vague descriptions like "it should work" are not helpful.
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.
description: |
Provide detailed, numbered steps that someone else can follow to reproduce the issue.
**Important:** Vague descriptions like "it doesn't work" or "it's broken" will result in the issue being closed.
Include specific actions, URLs, button clicks, and any relevant data or configuration.
placeholder: |
1. Go to the coffee pot.
2. Make more coffee.
3. Pour it into a cup.
4. Observe that the cup is empty instead of full.
validations:
required: true

- type: dropdown
id: deployment-environment
attributes:
label: Deployment Environment
description: How did you deploy the application?
description: How did you deploy the application? Only supported deployment methods are listed.
options:
- Docker Compose
- Docker Run
- Other
default: 0
validations:
required: true

- type: textarea
id: environment-configuration
attributes:
label: What is your environment & configuration?
description: Please add your docker compose file or docker run command used to deploy the application.
placeholder: Add information here.
value: |
```yaml
# (paste your configuration here)
```

Add more configuration information here.
validations:
required: true

- type: textarea
id: application-information
attributes:
Expand All @@ -71,16 +104,20 @@ body:
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.
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. If you are unsure which logs to include, include all logs. You can get the logs by running `docker logs <container_id/name>`.
render: shell
validations:
required: true
37 changes: 26 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,28 @@ 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).
Any reqeusts for new translations should be reqeusted within the [crowdin project](https://crowdin.com/project/speedtest-tracker).
- type: checkboxes
attributes:
label: Pre-work
label: Welcome!
description: |
The issue tracker is for reporting bugs and feature requests only. For end-user related support questions, please use the **[GitHub Discussions](https://github.com/alexjustesen/speedtest-tracker/discussions)** instead
Please note:
- For **Bug reports**, use the [Bug Form](https://github.com/alexjustesen/speedtest-tracker/issues/new?template=bug_report.yml).
- Any requests for new translations should be requested within the [crowdin project](https://crowdin.com/project/speedtest-tracker).
options:
- label: I have searched open and closed feature request to make sure this or similar feature request does not already exist.
- label: I have searched open and closed feature requests 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 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.
- label: This is a feature request, not a bug report or support question.
required: true
- label: I agree to follow this project's [Code of Conduct]().
- label: I agree to follow this project's [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md).
required: true

- type: dropdown
id: idea-section
attributes:
Expand All @@ -28,14 +34,23 @@ body:
- Notifications
- Speedtest
- Web UI/UX
- Other
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.
description: |
Describe the solution or feature you'd like. Explain what problem this solves or what value it adds.
**Important:** Be specific and detailed. Vague requests like "make it better" will be closed.
placeholder: |
Example:
- What is the feature?
- What problem does it solve?
- How should it work?
- Why would this be valuable?
validations:
required: true