Skip to content

feat(github): Add structured GitHub Issue Templates for bugs, features, and documentation #484

Description

@ayushsri-dev

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/:

  1. 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.
  2. 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.
  3. feature_request.yml:

    • Target component selection.
    • Textareas for problem description, proposed solution, and alternatives considered.
    • Content policy compliance check.
  4. documentation.yml:

    • Selection of affected documentation or setup guide.
    • Textareas for identifying incorrect/missing information and suggested updates.
  5. 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

  • .github/ISSUE_TEMPLATE/bug_report.yml is created and passes GitHub Issue Form schema validation.
  • .github/ISSUE_TEMPLATE/ui_ux.yml is created with device class and navigation/layout fields.
  • .github/ISSUE_TEMPLATE/feature_request.yml is created and validated.
  • .github/ISSUE_TEMPLATE/documentation.yml is created and validated.
  • .github/ISSUE_TEMPLATE/config.yml is created with blank_issues_enabled: true and relevant community links configured.
  • All forms include Arvio-specific component dropdowns and policy checkboxes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions