diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..9123be8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,65 @@ +name: Bug report +description: Report something that is not working in SpeakType. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this. + + If your SpeakType build has `Settings > General > Support`, click `Copy Support Info` and paste that output below. + If not, that is fine. Please include your SpeakType version and macOS version in the report description. + + - type: textarea + id: summary + attributes: + label: What happened? + description: Describe the problem and what you were trying to do. + placeholder: SpeakType started recording, but... + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: List the exact actions that trigger the issue. + placeholder: | + 1. Open SpeakType + 2. Press the hotkey + 3. ... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect SpeakType to do instead? + validations: + required: true + + - type: textarea + id: support-info + attributes: + label: Support info + description: Optional. Paste the output from `Settings > General > Support > Copy Support Info`. + render: shell + + - type: textarea + id: logs + attributes: + label: Screenshots or logs + description: Add screenshots, screen recordings, or relevant Console logs if available. + render: shell + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Before submitting + options: + - label: I searched existing issues and did not find the same report. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..d4e6be7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,61 @@ +name: Feature request +description: Suggest an improvement or new capability for SpeakType. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for helping shape SpeakType. A good feature request explains the workflow, not just the button. + + - type: textarea + id: problem + attributes: + label: Problem or workflow + description: What are you trying to do, and where does SpeakType get in the way? + placeholder: When I use SpeakType to... + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: Describe the behavior you would like to see. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Optional. Mention any workaround or different design you have tried. + validations: + required: false + + - type: dropdown + id: importance + attributes: + label: How important is this to your workflow? + options: + - Nice to have + - Important + - Blocking my use of SpeakType + validations: + required: true + + - type: textarea + id: examples + attributes: + label: Examples or references + description: Optional. Add screenshots, app examples, or links that clarify the request. + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Before submitting + options: + - label: I searched existing issues and did not find the same request. + required: true