From 61698b6e194d3b0caa58060a4f18d51c5f79f149 Mon Sep 17 00:00:00 2001 From: Riku Isokoski Date: Thu, 12 Jan 2023 22:46:30 +0200 Subject: [PATCH] Tweaked issue forms (#1267) When people suggest a solution to a generic issue they encounter, they have to open a feature request, which is not optimal. Submitting an issue through this new form will require writing about the issue that led to the idea, which will make it easier to discuss different solutions. --- .github/ISSUE_TEMPLATE/bug-report.yaml | 8 +--- .github/ISSUE_TEMPLATE/feature-request.yaml | 41 --------------------- .github/ISSUE_TEMPLATE/issue-report.yaml | 31 ++++++++++++++++ 3 files changed, 33 insertions(+), 47 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/issue-report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 6e9f6606..4c85742a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,15 +1,11 @@ name: Bug Report -description: File a bug report +description: Something is broken labels: ["bug"] body: - - type: markdown - attributes: - value: | - **Thanks for taking the time to fill out this bug report!** - *Please, before opening a bug report, check if similar issues already exist. In that case, use those issues to provide your feedback instead.* - type: checkboxes attributes: label: Verification + description: Before submitting a bug report, check if similar issues already exist and use those issues to provide your feedback instead. options: - label: I searched for similar bug reports and found none was relevant. required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml deleted file mode 100644 index a35bbfed..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ /dev/null @@ -1,41 +0,0 @@ -name: Feature Request -description: File a feature request -labels: ["feature request"] -body: - - type: markdown - attributes: - value: | - **Thanks for taking the time to fill out this feature request!** - *Please, before opening a feature request, check if similar issues already exist. In that case, use those issues to provide your feedback instead.* - - type: checkboxes - attributes: - label: Verification - options: - - label: I searched for similar feature request and found none was relevant. - required: true - - type: markdown - attributes: - value: | - **Note:** keep in mind that, while InfiniTime is usable, it is still under heavy development and as such it is continuously evolving. - Some features you want to see implemented might not be compatible with the current state of the project, or might not even be suitable to include *in the firmware* of the watch. - - type: input - id: desc-brief - attributes: - label: Pitch us your idea! - description: A one-line elevator pitch of the feature you'd like to see implemented. - placeholder: "Ex. My dog wants InfiniTime on its smart collar." - validations: - required: true - - type: textarea - id: desc-long - attributes: - label: Description - description: | - Give us a detailed description of the feature you are proposing. Mockups or a description of the possible use cases are highly appreciated. - Tell us why this should be included in the firmware. - placeholder: "Ex. Here is a drawing of my dog wearing an InfiniTime collar and smiling." - - type: markdown - id: companion-app - attributes: - value: | - If this requires features missing from other software (for example a companion app), please take care of opening any relevant feature request over there as well. diff --git a/.github/ISSUE_TEMPLATE/issue-report.yaml b/.github/ISSUE_TEMPLATE/issue-report.yaml new file mode 100644 index 00000000..f46499aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-report.yaml @@ -0,0 +1,31 @@ +name: Issue report +description: Something's not good enough +body: +- type: checkboxes + attributes: + label: Verification + description: Before submitting an issue, check if similar issues already exist and use those issues to provide your feedback instead. + options: + - label: I searched for similar issues and found none was relevant. + required: true +- type: textarea + attributes: + label: Introduce the issue + description: Explain why it is an issue if necessary. + validations: + required: true +- type: textarea + attributes: + label: Preferred solution + description: You can suggest a solution to the issue here. + placeholder: Optional +- type: input + attributes: + label: Version + description: | + What [version of the firmware](https://github.com/JF002/InfiniTime/blob/develop/doc/gettingStarted/gettingStarted-1.0.md#how-to-check-the-version-of-infinitime-and-the-bootloader) are you running? + If you are running an older version, please consider [updating to the latest firmware](https://github.com/JF002/InfiniTime/blob/develop/doc/gettingStarted/gettingStarted-1.0.md#how-to-update-your-pinetime). + If you are running directly from git, specify the branch or the commit hash directly. + placeholder: Ex. v1.6.0 or develop or fc922b60 + validations: + required: false