Skip to content

chore: add GitHub issue templates #554

@avelytchko

Description

@avelytchko

Add GitHub issue templates

Summary

The repository currently does not appear to have GitHub issue templates under .github/ISSUE_TEMPLATE. Adding issue templates would make reports more consistent, reduce back-and-forth with maintainers, and help contributors provide the information needed to reproduce bugs or evaluate feature requests.

GitHub supports both Markdown templates and YAML Issue Forms in .github/ISSUE_TEMPLATE. Issue Forms are preferable here because they can require key fields and guide users through structured reports.

Suggested Templates

Add the following files:

.github/
  ISSUE_TEMPLATE/
    bug_report.yml
    feature_request.yml
    documentation.yml

Proposed Forms

bug_report.yml

Purpose: reproducible app bugs.

Suggested required fields:

  • Description
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Browser and OS
  • Device type: desktop / mobile / tablet
  • Account state: signed in / signed out
  • Affected area:
    • Timer
    • Solves
    • Stats
    • Cubes
    • Account/Auth
    • Backups/Sync
    • Multiplayer
    • Trainer
    • Community/Profiles
    • Other
  • Screenshots or recordings
  • Console/network errors, if available

feature_request.yml

Purpose: product improvements and new functionality.

Suggested required fields:

  • Problem or use case
  • Proposed solution
  • Alternatives considered
  • Affected area
  • Why this matters for speedcubing/timer workflows

documentation.yml

Purpose: README, CONTRIBUTING, setup, deployment, env vars, or docs issues.

Suggested required fields:

  • Page/file affected
  • What is confusing or outdated
  • Suggested correction
  • Environment/context, if setup-related

Why This Helps

  • Bug reports become easier to reproduce.
  • Auth/database/deployment issues can collect browser, account state, and logs upfront.
  • Feature requests become easier to compare and prioritize.
  • Translation contributions get a consistent format.
  • Security reports are steered away from public issues.

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