element-hq / element-hq/element-ios

Suggestion: Have a "file a bug" button which goes to an issue form with prefilled variables

Open
#5,176 0 comments 0 reactions 0 assignees View on GitHub
A-Settings T-Enhancement X-Needs-Product
Dominant language
Swift
Stars
1.8k
Forks
544
PR merge metrics
PR metrics pending

Description

### Your use case

#### What would you like to do?

Add a "File a bug on github" button to Element, and/or to rageshakes, to easily file bugs.

#### Why would you like to do it?

This would lower the threshold for filing bugs.

#### How would you like to achieve it?

Github has issue forms now, but one small thing that i just discovered is that you can prefill variables.

Compare the following URL to the following issue template;

```
https://github.com/vector-im/element-ios/issues/new?assignees=&labels=T-Defect&template=bug.yml&version=v1.6.5
```

https://raw.githubusercontent.com/vector-im/element-ios/develop/.github/ISSUE_TEMPLATE/bug.yml

This pre-fills the "version" part of the report, leaving the user only to note down reproducability steps.

The local app could collect all version and install information on its own, such as OS (if possible), Version, Device, etc.

Note: For cross-version compatibility, it may be best for element.io to set up a bounce service, where the client just gives variables, and the service redirects to the latest bug-issue template, so this doesn't have to be hardcoded in the client.

Note 2: This would only work for github users, which would have to log in, it might not be very useful for every other user.

### Have you considered any alternatives?

_No response_

### Additional context

_No response_

Contributor guide

Open the contributing guide

Research direction

Review the linked element-ios bug.yml issue form and the proposed GitHub URL parameters first. Determine whether the iOS app, rageshakes, or a bounce service should own the button and version/device collection. Done means users can open a prefilled bug report with the relevant installation details while preserving compatibility with the current form.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, swift
Domain
mobile, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.