From 7d69201f4d140ec1bc8a9bbb6af51247abbf9f0f Mon Sep 17 00:00:00 2001 From: Your Name Date: Fri, 10 Oct 2025 19:56:32 -0600 Subject: [PATCH] Add structured GitHub issue forms --- .github/ISSUE_TEMPLATE/bug-report.yml | 80 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 30 -------- .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/crash-report.yml | 77 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/crash_report.md | 26 ------- .github/ISSUE_TEMPLATE/feature-request.yml | 33 +++++++++ 6 files changed, 198 insertions(+), 56 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/crash-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/crash_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..dc042997b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,80 @@ +name: Bug report +description: Report a reproducible issue in the Habitica Android app. +title: "[Bug]: " +labels: + - Type: Bug +body: + - type: markdown + attributes: + value: | + Thanks for helping us improve the Habitica Android app! Please fill out the checklist below so we can investigate quickly. + - type: textarea + id: summary + attributes: + label: Describe the bug + description: Provide a clear and concise description of the behaviour you observed. + placeholder: When I... + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: List the steps we can follow to reproduce the issue reliably. + placeholder: | + 1. Go to ... + 2. Tap on ... + 3. Observe ... + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: Tell us what you expected to happen instead. + placeholder: I expected... + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots or recordings + description: Drag and drop images or videos that show the issue, if applicable. + - type: markdown + attributes: + value: "### Environment" + - type: input + id: device + attributes: + label: Device + description: Your device model (e.g., Pixel 7, Samsung S23). + placeholder: Pixel 7 + validations: + required: true + - type: input + id: os + attributes: + label: Android version + description: The Android version installed on your device. + placeholder: Android 14 + validations: + required: true + - type: input + id: app_version + attributes: + label: App version/build + description: You can find this under Settings → About in the Habitica app. + placeholder: 4.0.0 (1234) + validations: + required: true + - type: input + id: username + attributes: + label: Habitica username + description: Optional but helpful for follow-up. + placeholder: Username (optional) + - type: textarea + id: additional + attributes: + label: Additional context + description: Include crash logs, logcat output, or any other context that might help. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index cc1617cf1..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'Type: Bug' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. If your issue is not related to a specific bug, please submit it as a suggestion through our form: https://forms.gle/Fa6oztkDsbzLqSvE9 - -**To Reproduce** -Steps to reproduce the behavior: - - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Smartphone (please complete the following information):** - - Device: [e.g. Moto G5] - - OS: [e.g. Android 9] - - App Version: [e.g. 2.2] - - Habitica Username: - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..02c400114 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Habitica Help Desk + url: https://habitica.freshdesk.com/support/home + about: Account, billing, or other support requests not related to the Android codebase. + - name: Feature suggestion portal + url: https://forms.gle/Fa6oztkDsbzLqSvE9 + about: Share high-level product ideas that are not specific to the Android app implementation. diff --git a/.github/ISSUE_TEMPLATE/crash-report.yml b/.github/ISSUE_TEMPLATE/crash-report.yml new file mode 100644 index 000000000..b45dc1b88 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash-report.yml @@ -0,0 +1,77 @@ +name: Crash report +description: Report a crash or app freeze in the Habitica Android app. +title: "[Crash]: " +labels: + - Type: Crash +body: + - type: markdown + attributes: + value: | + Thanks for reporting a crash. Please include as much detail as possible so we can diagnose the issue. + - type: textarea + id: summary + attributes: + label: Describe the crash + description: Let us know what happened and what you were doing when the app crashed or froze. + placeholder: The app crashed when... + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: Can you reproduce the crash consistently? If so, list the steps. + placeholder: | + 1. Launch the app + 2. ... + 3. Crash occurs + validations: + required: true + - type: textarea + id: logs + attributes: + label: Crash logs or logcat output + description: Paste stack traces or logcat output if available. You can also attach files below the form. + - type: textarea + id: media + attributes: + label: Screenshots or screen recording + description: Attach any visual evidence that helps us see what happened. + - type: markdown + attributes: + value: "### Environment" + - type: input + id: device + attributes: + label: Device + description: Your device model (e.g., Pixel 7, Samsung S23). + placeholder: Pixel 7 + validations: + required: true + - type: input + id: os + attributes: + label: Android version + description: The Android version installed on your device. + placeholder: Android 14 + validations: + required: true + - type: input + id: app_version + attributes: + label: App version/build + description: You can find this under Settings → About in the Habitica app. + placeholder: 4.0.0 (1234) + validations: + required: true + - type: input + id: username + attributes: + label: Habitica username + description: Optional but helpful for follow-up. + placeholder: Username (optional) + - type: textarea + id: additional + attributes: + label: Additional context + description: Mention any other details that might help us identify the issue (network conditions, account state, etc.). diff --git a/.github/ISSUE_TEMPLATE/crash_report.md b/.github/ISSUE_TEMPLATE/crash_report.md deleted file mode 100644 index 7a79469ec..000000000 --- a/.github/ISSUE_TEMPLATE/crash_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Crash report -about: Create a report for app crash instances -title: '' -labels: 'Type: Crash' -assignees: '' - ---- - -**Describe the crash** -What were you doing before the issue? Was there an error, did the app stall, or did it fully close? - -**To Reproduce** -Can you reliably reproduce the crash? If so, list steps. - -**Screenshots/Video** -If applicable, add screenshots or video to help show the problem - -**Smartphone (please complete the following information):** - - Device: [e.g. Moto G5] - - OS: [e.g. Android 9] - - App Version: [e.g. 2.2] - - Habitica Username: - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..b043d658c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Suggest an enhancement or new idea for the Habitica Android app. +title: "[Feature]: " +labels: + - Type: Enhancement +body: + - type: markdown + attributes: + value: | + Thanks for sharing your idea! Before submitting, please confirm the idea has not already been suggested in the issue tracker or the Habitica Trello board. + - type: textarea + id: summary + attributes: + label: Describe the solution you'd like + description: What problem are you trying to solve and how should the app change? + placeholder: I'd like the app to... + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem statement + description: Explain the problem or user need that this feature will address. + - type: textarea + id: alternatives + attributes: + label: Alternatives you've considered + description: Are there existing features or workarounds that partly address the need? + - type: textarea + id: notes + attributes: + label: Additional context + description: Include mockups, references, or other information that helps us understand the request.