Skip to content
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.

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

Add issue template when reporting a bug #6017

Merged
merged 4 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/10_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Bug report for QField (not any other QField ecosystem product)
description: Create a bug report to help us improve QField.
labels:
- 'Bug'
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report correctly.

Please report only issues related to the QField application, and not QFieldSync, QFieldCloud, QFieldCloud SDK, or QField plugins.
Note that feature requests should not be requested here.
You can go one step back and choose the right place to put your report.

- type: textarea
id: what
attributes:
label: What is the bug or the crash? What were your expectations and what actually happened?
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce the issue
description: |
Steps and sample QField project as a .zip to reproduce the behavior. Screen recordings or screenshots are more than welcome, you can drag&drop them in the textbox.
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true

- type: textarea
id: qfield-version
attributes:
label: Version
description: |
In the QField main menu -> About, then paste the QField version here.
Do not make a screenshot.
validations:
required: true

- type: dropdown
id: qfield-os-name
attributes:
label: Operating system name
description: |
What is your operating system name?
options:
- Android
- iOS
- Linux
- MacOs
- Windows
- Other (please specify in additional context)
validations:
required: true

- type: input
id: qfield-os-version
attributes:
label: Operating system version
description: |
What is your operating system version?
validations:
required: true

- type: checkboxes
id: cleaned-data
attributes:
label: Reinstall QField
description: |
Have you tried uninstalling and upgrading to the latest QField version, or tried to replicate the issue with another project?
options:
- label: I have a fresh install of the latest QField version, but the problem persists.
- label: Problem can be reliably reproduced, doesn't happen randomly.
- label: Problem happens with all files and projects, not only some files or projects.

- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context about the problem here.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
blank_issues_enabled: false

contact_links:
- name: Enhancement proposals/feature requests for the QField ecosystem
url: https://ideas.qfield.org
about: >
Add your suggestion how to improve QField, QFieldSync, QFieldCloud or QFieldCloud SDK at https://support.qfield.cloud/ .

- name: Support for your QFieldCloud account at [app.qfield.cloud](https://app.qfield.cloud)
url: https://support.qfield.cloud
about: >
Open a ticket at our support platform for app.qfield.cloud users at https://support.qfield.cloud/ .

- name: Bug report for QFieldSync
url: https://github.com/opengisch/QFieldSync/issues
about: >
Check if your issue was already reported and if not, then create a new issue at the QFieldSync repository.

- name: Bug report for QFieldCloud SDK
url: https://github.com/opengisch/QFieldCloud-sdk-python/issues
about: >
Check if your issue was already reported and if not, then create a new issue at the QFieldCloud Python SDK repository.

- name: Commercial and community support
url: https://docs.qfield.org/get-started/support/
about: >
Check how to get commercial or community support for your QField ecosystem questions.

- name: Missing documentation (QField, QFieldSync, QFieldCloud, QFieldCloud SDK)
url: https://github.com/opengisch/qfield-docs/issues
about: >
Suggest improvements or report documentation errors regarding https://docs.qfield.org .

- name: QField plugin issue
url: https://github.com/topics/qfield-plugin
about: >
If the issue concerns a third party plugin (downloaded within the QField plugin manager)
then it can't be fixed by the QField core team.
Please raise your issue in the dedicated bug tracker for that specific plugin.
Loading