diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 34b9da9..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug Report -about: Report a bug in the Torii SRS Web App -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..0674447 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,130 @@ +name: Bug report +description: Something in the Torii web app is broken or behaving strangely. +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time. Two quick things that fix many reports: + **reload the page**, and check the **cloud icon** at the foot of the navigation menu — + items queued there mean you're offline or the server is out of reach. + + Still broken? Fill this in. The [Knowledge Base](https://app.torii-srs.com/faq) covers + the common ones if you'd rather check first. + + - type: checkboxes + id: checks + attributes: + label: Before you post + options: + - label: I searched the existing issues, including closed ones. + required: true + - label: I reloaded the page and it still happens. + required: true + - label: I'm not in a private/incognito window (Torii can't start in one). + required: true + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What you saw, in your own words. + placeholder: The answer field stopped accepting input after I got a word wrong. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Enough that we can do the same thing and watch it break. + placeholder: | + 1. Start a review session + 2. Answer a meaning question wrong + 3. Press Enter to continue + 4. … + validations: + required: true + + - type: textarea + id: expected + attributes: + label: What did you expect instead? + validations: + required: true + + - type: dropdown + id: area + attributes: + label: Where in the app? + options: + - Reviews + - Lessons + - Self-study + - Dashboard + - Browse + - Add words + - Stats + - Settings + - Sign-in / sign-up + - Knowledge Base + - Support Torii / membership + - Somewhere else + validations: + required: true + + - type: dropdown + id: browser + attributes: + label: Browser + options: + - Chrome + - Firefox + - Safari + - Edge + - Brave / Vivaldi / Arc + - Other + validations: + required: true + + - type: input + id: device + attributes: + label: Device, OS and browser version + placeholder: iPhone 14, iOS 18.3, Safari 18 + validations: + required: true + + - type: dropdown + id: install + attributes: + label: How were you using Torii? + options: + - In a browser tab + - Installed as an app (added to home screen / desktop) + validations: + required: true + + - type: checkboxes + id: conditions + attributes: + label: Anything true at the time? + options: + - label: I was offline, or my connection was unreliable. + - label: It happens every time. + - label: It started after a recent update. + + - type: textarea + id: extra + attributes: + label: Screenshots or anything else + description: Drag images straight in. A screenshot of the moment it went wrong is worth a lot. + + - type: markdown + attributes: + value: | + --- + **Got an account?** The in-app contact form (*Knowledge Base → Still stuck?*) can attach a + diagnostics file — a record of what the app did on your device, with no email address and + nothing you wrote in it. Send it there rather than here (this tracker is public) and + mention the issue number. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..443cccf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Knowledge Base — how Torii works + url: https://app.torii-srs.com/faq + about: Searchable answers on lessons, reviews, the SRS stages, offline mode and accounts. Start here for questions. + - name: Account, payments or your data + url: https://app.torii-srs.com/faq#still-stuck + about: Anything needing your email address. Issues here are public, so please write to us instead. + - name: Anything else + url: https://app.torii-srs.com/faq#still-stuck + about: No account, or nothing above fits. We read every one. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 4c03128..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature Request -about: Suggest a feature for Torii SRS -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8ee099f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,57 @@ +name: Feature request +description: Suggest something new, or a change to how something works. +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Ideas are welcome, and the good ones usually start from a real annoyance rather than a + feature name — so tell us what's in your way, not only what to build. + + - type: checkboxes + id: checks + attributes: + label: Before you post + options: + - label: I searched the existing issues, including closed ones. + required: true + + - type: textarea + id: problem + attributes: + label: What's the problem? + description: What are you trying to do, and where does Torii get in the way? + placeholder: I study on the train and lose my place whenever the tunnel kills the connection. + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: What would you like Torii to do? + validations: + required: true + + - type: textarea + id: workaround + attributes: + label: How do you handle it today? + description: Workarounds tell us how much the current behaviour costs you. + + - type: dropdown + id: area + attributes: + label: Which part of the app? + options: + - Reviews + - Lessons + - Self-study + - Dashboard + - Browse + - Add words + - Stats + - Settings + - Offline & syncing + - Something else / the whole app + validations: + required: true \ No newline at end of file