Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions ,github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: "Bug Report"
description: "Report a reproducible bug or crash in the app."
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug. Your feedback helps improve the app.

- type: markdown
attributes:
value: |
Before submitting a new issue, **please search the issue tracker** to ensure it hasn’t already been reported.

- type: textarea
id: issue-description
attributes:
label: Describe the bug
description: |
Provide a clear and concise description of the issue.

**Example:**
"When I tap the settings button, the app crashes instead of opening the settings screen."
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: List the steps required to reproduce the issue.
placeholder: |
1. Open the app
2. Tap on 'Settings'
3. Observe the crash
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Explain what should happen instead.
placeholder: |
"Tapping the settings button should navigate to the settings screen."
validations:
required: true

- type: textarea
id: screenshots-or-videos
attributes:
label: Screenshots or Videos (if applicable)
description: |
Attach screenshots or videos that help explain the issue.

**Tip:** Drag and drop files here or use the attachment button below.
validations:
required: false

- type: input
id: device
attributes:
label: Device/Emulator Information
description: Specify the device or emulator used for testing.
placeholder: e.g., Pixel 6
validations:
required: false

- type: input
id: android-version
attributes:
label: Android Version
description: Provide the Android version running on the device/emulator.
placeholder: e.g., Android 14
validations:
required: false

- type: textarea
id: logs
attributes:
label: Log Output (if applicable)
description: |
Paste relevant logs from Logcat or crash reports.

**Tip:** Use triple backticks (```) to format logs properly.
render: shell
validations:
required: false
50 changes: 50 additions & 0 deletions ,github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: "Feature Request"
description: "Suggest a new feature or improvement"
title: "[Feature Request]: "
labels: ["feature request"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to submit a feature request. Your feedback helps improve the project.

- type: markdown
attributes:
value: |
Before submitting a new request, **please check the issue tracker** to ensure it hasn’t already been proposed.

- type: textarea
id: description
attributes:
label: Description
description: |
Clearly explain what needs to be added or improved.

**Example:**
"Set up the Android project structure with appropriate modules and dependencies."
"Add a bottom navigation bar for easier navigation."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Describe how this feature should work and what improvements it would bring.

**Example:**
"Adding a bottom navigation bar would allow users to switch screens quickly."
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Provide any other relevant details, mockups, or screenshots related to this feature request.

**Tip:** Drag and drop images or files here to attach them.
validations:
required: false
51 changes: 51 additions & 0 deletions ,github/ISSUE_TEMPLATE/3_enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: "Enhancement"
description: "Suggest improvements or optimizations to existing code."
title: "[Enhancement]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a refactor or enhancement. Improving code quality and performance benefits the entire project.

- type: markdown
attributes:
value: |
Before submitting a new request, **please check the issue tracker** to ensure it hasn’t already been proposed.

- type: textarea
id: improvement-summary
attributes:
label: Summary of Improvement
description: |
Briefly describe the improvement or refactor needed.

**Example:**
"Optimize the data caching mechanism to improve performance."
"Refactor the API service layer to improve maintainability."
validations:
required: true

- type: textarea
id: current-implementation
attributes:
label: Current Implementation
description: |
Describe how the current implementation works and any issues with it.

**Example:**
"The API calls are handled in multiple places, making maintenance difficult."
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: |
Explain how this should be improved or refactored.

**Example:**
"Move API calls to a dedicated repository class and use dependency injection for better testability."
validations:
required: true
2 changes: 2 additions & 0 deletions ,github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Disables the ability to open blank issues. Users must select an issue template.
blank_issues_enabled: false
14 changes: 14 additions & 0 deletions ,github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- This will be automatically replaced by a summary generated by CodeRabbitAI -->
@coderabbitai summary

## Issue Reference
* Fixes #<!-- replace this comment with the issue number, e.g., 'Fixes #1234' -->

## Screenshots
<!-- Upload before-and-after screenshots for UI-related changes. Include both light and dark mode views if relevant. -->

## Essential Checklist
<!-- Please tick the relevant boxes by putting an "x" in them (and remove additional spaces). -->
* [ ] The PR title starts with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...").
* [ ] The PR does not contain any unnecessary code changes from Android Studio.
* [ ] The PR is made from a branch that is **not** called "main" and is up-to-date with "develop".