Compare commits

...

3 commits
1.0.0 ... main

Author SHA1 Message Date
Your Name
7d69201f4d Add structured GitHub issue forms 2025-10-10 19:56:49 -06:00
sudoxnym
82795105c4
Merge pull request #1 from sudoxnym/feature/unifiedpush-gate
Feature/unifiedpush gate
2025-10-10 18:19:25 -06:00
Your Name
a51d4d50c9 Document pairing with habitica-self-host server 2025-09-25 18:12:50 -06:00
7 changed files with 201 additions and 57 deletions

80
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View file

@ -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.

View file

@ -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.

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -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.

77
.github/ISSUE_TEMPLATE/crash-report.yml vendored Normal file
View file

@ -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.).

View file

@ -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.

View file

@ -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.

View file

@ -20,6 +20,8 @@ See the project's Releases page for a list of versions with their changelogs.
##### [View Releases](https://github.com/HabitRPG/habitrpg-android/releases)
If you are deploying the companion self-hosted server (`https://github.com/sudoxnym/habitica-self-host`), use the APKs named below so the login screen can target that backend out of the box.
Self-hosted builds published from this repository include two APKs in each release:
- `habitica-self-host-debug.apk` debuggable build with developer tooling enabled
@ -66,7 +68,7 @@ We use Kotlin and follow the code style based on the [Android Kotlin Style Guide
Note: this is the default production `habitica.properties` file for habitica.com. If you want to use a local Habitica server, please modify the values in the properties file accordingly.
When running a self-hosted build you can now switch servers directly from the login screen. Tap the gear icon in the upper-right corner seven times to unlock the developer options dialog, enter your custom base URL, and (optionally) enable UnifiedPush with the distributor installed on the device.
When running a self-hosted build you can now switch servers directly from the login screen—ideal for pairing with [`habitica-self-host`](https://github.com/sudoxnym/habitica-self-host). Tap the gear icon in the upper-right corner seven times to unlock the developer options dialog, enter your custom base URL, and (optionally) enable UnifiedPush with the distributor installed on the device.