Bug reports¶

If you think you have discovered a bug, you can help us by submitting an issue in our public issue tracker, following this guide.

Before creating an issue¶

• Upgrade to the latest version. Chances are that the bug you discovered was already fixed in a subsequent version.
• Search our documentation and look for the relevant sections that could be related to your problem. If found, make sure that you have configured everything correctly.
• Search our issue tracker, as another user might already have reported the same problem, and there might even be a known workaround or fix. Thus, no need to create a new issue.

At this point, when you still haven't found a solution to your problem, we encourage you to create an issue because it's now very likely that you stumbled over something we don't know yet. Read the following section to learn how to create a complete and helpful bug report.

Issue template¶

Title¶

A good title is short and descriptive. It should be a one-sentence executive summary of the issue, so the impact and severity of the bug you want to report can be inferred from the title.

App¶

Provide the application name for which you are filling the bug report.

Description¶

Provide a clear, focused, specific, and concise summary of the bug you encountered. Explain why you think this is a bug that should be reported. Adhere to the following principles:

• Explain the what, not the how – don't explain how to reproduce the bug here, we're getting to that later. Focus on articulating the problem and its impact as clearly as possible.
• Keep it short and concise – if the bug can be precisely explained in one or two sentences, perfect. Don't inflate it – maintainers and future users will be grateful for having to read less.
• One bug at a time – if you encounter several unrelated bugs, please create separate issues for them. Don't report them in the same issue, as this makes attribution difficult.

Stretch goal – if you found a workaround or a way to fix the bug, you can help other users temporarily mitigate the problem before we maintainers can fix the bug in our code base.

Steps to reproduce¶

Please list the specific steps we should follow when running your reproduction to observe the bug. Keep the steps concise, and make sure not to leave anything out. Use simple language as you would explain it to a five-year-old, and focus on continuity.

Expected behavior¶

Explain what you expected to happen.

Environment¶

If applicable, add screenshots to help explain your problem.

Screenshots¶

Upload screenshots that could help understand the problem.