diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dbe95756d8..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -labels: bug ---- - -Please see the appropriate readme section for issue reporting guidelines: https://github.com/HeliBorg/HeliBoard?tab=readme-ov-file#reporting-issues -tl;dr: -* search for duplicates, also in closed issues -* a single issue per topic -* reduce screenshot size -* write it yourself - - - -**Describe the bug** - -**To Reproduce** -If possible, provide all the necessary steps to reproduce your problem, including the involved apps and text field or settings if relevant. -In case you cannot reproduce the bug, say so and provide information about when the bug may occur for you. Settings and the app you're writing in are usually important, please don't omit them. - -**Expected behavior** -If it's not obvious (e.g. not crash), describe how you think the app should behave. - -**Screenshots** -ONLY add screenshots when they add real value. -If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable. - -**App version** -Please provide the explicit version (not just "latest"), or if you build the app yourself specify the latest commit. - -**Device:** - - Model: [e.g. Samsung Galaxy S9] - - OS: [e.g. Android 10] (please also mention whether you are using the manufacturer's OS or a custom ROM) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..164331816e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,119 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug] " +labels: ["bug"] +assignees: [] + +body: + - type: markdown + attributes: + value: Please see the appropriate readme section for [issue reporting guidelines](https://github.com/HeliBorg/HeliBoard?tab=readme-ov-file#reporting-issues) + + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I confirm that the issue is NOT a duplicate of any both OPEN and CLOSED issues + required: true + - label: I confirm I am using the LATEST version - check [here](https://github.com/HeliBorg/HeliBoard/releases) + required: true + - label: I understand that issues regarding layout customization most likely will be resolved by editing [JSON file](https://github.com/HeliBorg/HeliBoard/blob/main/layouts.md#json-format) + required: true + - label: I write this issue by myself, if it is AI-generated I have verify the correctness of the provided info + required: true + - label: I have attached the error report in the issue + required: false + - label: I have reduced any attached screenshot image size + required: false + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: | + A clear and concise description of what the bug is + ONLY add screenshots when they add real value + If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable + placeholder: + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: Describe how the app should behave + placeholder: | + Actual: + + Expected: + validations: + required: true + + - type: dropdown + id: frequency + attributes: + label: Frequency + description: How often does this bug occur? + options: + - Always (100% of the time) + - Often (80-90% of the time) + - Sometimes (40-60% of the time) + - Rarely (10-30% of the time) + - Only once (single occurrence) + default: 4 + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: Steps to reproduce the bug + description: | + Please provide detailed steps to reproduce the issue + In case you cannot reproduce the bug, say so and provide information about when the bug may occur for you + Settings and the app you're writing in are usually important, please don't omit them + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: Please provide the explicit version (not just "latest"), or if you build the app yourself specify the latest commit. + placeholder: e.g. 4.1.3 + validations: + required: true + + - type: input + id: rom + attributes: + label: ROM version + description: What Android Version and ROM are you using? + placeholder: e.g. Android 16 OneUI 8 + validations: + required: true + + - type: input + id: device + attributes: + label: Device + description: What device are you using? + placeholder: e.g. Samsung Galaxy S24 + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here + placeholder: Any additional information that might help us understand the issue + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 08642be538..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -labels: enhancement ---- - -Please see the appropriate readme section for issue reporting guidelines: https://github.com/HeliBorg/HeliBoard?tab=readme-ov-file#reporting-issues -tl;dr: -* search for duplicates, also in closed issues -* check FAQ / hidden features -* a single issue per topic -* ONLY add screenshots when necessary, and reduce their size -* write it yourself - - - - - -**Is your feature request related to a problem? Please describe.** - -**Describe the solution you'd like** -Please provide a description of what you would like to have. The clearer it is described, the better it can be implemented the way you want it. - -**Use case** -Provide a clear and concise description of *your use case* and what you thus think is missing, and why. - -**Describe alternatives you've considered (if any)** - -**App version** -Please provide the explicit version, you're using. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..da2bac9a21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,60 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature request] " +labels: ["feature-request"] +assignees: [] +body: + - type: markdown + attributes: + value: Please see the appropriate readme section for [issue reporting guidelines](https://github.com/HeliBorg/HeliBoard?tab=readme-ov-file#reporting-issues) + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please confirm the following before submitting your feature request + options: + - label: I have searched for existing issues (open and closed) and confirmed this feature hasn't been requested before + required: true + - label: I understand that requests regarding layout customization most likely will be resolved by editing [JSON file](https://github.com/HeliBorg/HeliBoard/blob/main/layouts.md#json-format) + required: true + - label: I believe this feature request will benefit more than 10% of users, not just myself + required: true + - label: I have reduced any attached image size to make it easier to read + required: false + + - type: textarea + id: description + attributes: + label: Feature Description + description: Please provide a description of what you would like to have. The clearer it is described, the better it can be implemented the way you want it. + placeholder: Describe your feature request here... + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Provide a clear and concise description of your use case and what you thus think is missing, and why. + placeholder: + validations: + required: true + + - type: textarea + id: alternative-solution + attributes: + label: Alternative solution + description: Describe alternatives you've considered (if any) + placeholder: + validations: + required: false + + - type: input + id: version + attributes: + label: Version + description: Please provide the explicit version (not just "latest"), or if you build the app yourself specify the latest commit. + placeholder: e.g. 4.1.3 + validations: + required: true