Report an issue

[alexjpwalker]

Problem to Solve

We want it to be as easy as possible for users to report issues to us directly.

This requires:

• 440

Proposed Solution

• [ ] Add a button to Error Details that allows the user to report their error directly to us. We need a suitable channel for receiving error reports. GitHub issues is one option. We could simply bring up a little dialog with links to our Discord, GitHub, and Discussion Forum. This has its pros and cons - we'd get less reports if we required users to take this step, but on the other hand it would open a conversation, which could be really valuable for working on the issue.
• [ ] Add a button to the Help menu to report an issue (should just open https://github.com/vaticle/typedb-studio/issues in a web browser)
• [x] Maybe add a user option to opt-in to automated error reporting - but we'd need to set up an API to receive errors, and ensure we aren't sending personal data or TypeQL data across.

[jamesreprise]

We should allow for the user to automatically add additional information such as the schema, their environment (Versions of OS, TypeDB, Studio, device specs) so that we have all the required information in as few steps as possible.

The potential to be able to replicate the user's environment into our own quickly is a strong argument in favour of an API.

[jamesreprise]

We're not adding new features this cycle, so we're removing this from the milestone.

[alexjpwalker]

Partially implemented in

• https://github.com/vaticle/typedb-studio/pull/815