Skip to content

Automatic Bug Reporting #334

@SuperCoolPencil

Description

@SuperCoolPencil

Currently, users must manually look up the application version, build number, and operating system details, then navigate to GitHub and paste that information into a new issue. This process is prone to human error, often results in incomplete reports, and discourages users from providing feedback due to the friction involved.

Describe the solution you'd like
A "Report a Bug" button integrated directly into the application UI, likely within the Help or About menu. When clicked, this button should gather relevant system metadata—such as the app version, commit hash, and OS environment—and open a web browser to the GitHub "New Issue" page. The issue title and body should be pre-populated with these technical details formatted in a clean markdown template, leaving a designated space for the user to describe their specific experience.

Describe alternatives you've considered
One alternative is providing a "Copy System Info" button that copies the technical details to the clipboard, requiring the user to manually paste them into a GitHub issue. Another option is an in-app feedback form that sends data to a backend API or email, but this is less transparent than a public GitHub issue and requires maintaining a separate reporting infrastructure.

Additional context
The implementation can utilize GitHub URL query parameters (title and body) to pass the gathered data. This ensures the technical environment is documented exactly as it exists at the time of the crash or error, which significantly reduces the back-and-forth communication needed between developers and users to identify the cause of a bug.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions