Hey team, this is a guide on how you can file useful issues.
If you have access to linear, please create issues there. Otherwise you can create a Github issue or create a comment in the Community Support page.
Reproduction Steps
This is the most important part of a good issue, and it is often left out from an issue description.
Describe how this issue can happen for other people, on other machines, with other databases.
What data was created or downloaded that causes this situation? If the issue happens only with a specific piece of content, provide the URL so that other people can experience this.
Keep in mind, other people have different databases than you do, so you might get an error that other people do not. If you can, provide specifics about how somebody else with a fresh database can experience the same bug. Feel free to back up your database, check the error reproduction steps after deleting the db, and then copy back your backup to keep your drafts/favorites/subscriptions.
This can be time consuming but it is super important: see if you can get the same issue to happen again! Some issues are totally inconsistent, even when you follow the exact same steps. And that can be useful information for the developer fixing it. (Does it happen 100% of the time, 10% of the time, or something else?)
Expected Behavior
If something happens but you think its not quite right, explain what you expected to happen.
When the issue is about an error, then you can skip this because clearly the error is not expected.
Actual Behavior
Provide details about what actually happened. Attach a screenshot.
If you can, include logs from the frontend or backend.