Description
This issue proposes introducing structured GitHub Issue Forms (YAML format) under .github/ISSUE_TEMPLATE/ to streamline bug reporting, UI/UX feedback, feature requests, and documentation improvements for the Arvio repository.
Current State
The repository currently lacks .github/ISSUE_TEMPLATE/ files. All issues opened by users or contributors default to GitHub's generic unguided blank text editor.
Because Arvio features multi-device user interfaces (Android TV 10-foot UI with D-pad navigation, Android Mobile touch UI, Next.js Web UI) alongside cloud/backend services, unguided reports frequently lack critical details such as target device class, interaction mode, app variant (play vs sideload), or visual screenshots.
Proposed Changes
Create modern GitHub Issue Forms (YAML) in .github/ISSUE_TEMPLATE/:
-
bug_report.yml:
- Dropdown for affected component (Android App, Web App, iOS App, Supabase/Edge Functions, Resolver Worker, IPTV/EPG, Player).
- Input for app variant (
play, sideload, web) and device/OS environment.
- Textareas for reproduction steps, expected behavior, actual behavior, and logs/screenshots.
- Checkbox confirming adherence to Arvio's Content and Source Policy.
-
ui_ux.yml:
- Dropdown for target device form factor (Android TV 10-foot UI, Mobile/Tablet Touch UI, Web/Desktop UI, iOS UI).
- Dropdown for issue category (Focus / D-pad Navigation, Visual / Layout alignment, Motion / Transition, Design improvement proposal).
- Textareas for screen/component location, problem description, expected behavior/mockups, and visual screenshots.
-
feature_request.yml:
- Target component selection.
- Textareas for problem description, proposed solution, and alternatives considered.
- Content policy compliance check.
-
documentation.yml:
- Selection of affected documentation or setup guide.
- Textareas for identifying incorrect/missing information and suggested updates.
-
config.yml:
- Enable blank issues (
blank_issues_enabled: true) for open-ended reporting.
- Add links to repository documentation and Ko-fi support page.
Benefits
- Dedicated UI/UX Intake: Captures D-pad focus navigation issues, TV vs. Mobile layout regressions, and design proposals with dedicated fields and screenshot requests.
- Faster Triage: Ensures maintainers receive actionable bug reports with platform, variant, and environment details on initial submission.
- Policy Enforcement: Reminds authors of Arvio's Content & Source Policy before submitting reports.
- Flexibility: Keeps blank issues enabled for unstructured or non-standard reports.
Acceptance Criteria
Description
This issue proposes introducing structured GitHub Issue Forms (YAML format) under
.github/ISSUE_TEMPLATE/to streamline bug reporting, UI/UX feedback, feature requests, and documentation improvements for the Arvio repository.Current State
The repository currently lacks
.github/ISSUE_TEMPLATE/files. All issues opened by users or contributors default to GitHub's generic unguided blank text editor.Because Arvio features multi-device user interfaces (Android TV 10-foot UI with D-pad navigation, Android Mobile touch UI, Next.js Web UI) alongside cloud/backend services, unguided reports frequently lack critical details such as target device class, interaction mode, app variant (
playvssideload), or visual screenshots.Proposed Changes
Create modern GitHub Issue Forms (YAML) in
.github/ISSUE_TEMPLATE/:bug_report.yml:play,sideload,web) and device/OS environment.ui_ux.yml:feature_request.yml:documentation.yml:config.yml:blank_issues_enabled: true) for open-ended reporting.Benefits
Acceptance Criteria
.github/ISSUE_TEMPLATE/bug_report.ymlis created and passes GitHub Issue Form schema validation..github/ISSUE_TEMPLATE/ui_ux.ymlis created with device class and navigation/layout fields..github/ISSUE_TEMPLATE/feature_request.ymlis created and validated..github/ISSUE_TEMPLATE/documentation.ymlis created and validated..github/ISSUE_TEMPLATE/config.ymlis created withblank_issues_enabled: trueand relevant community links configured.