Reporting bugs

This page guides you through submitting a bug report for CemrgApp. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behaviour 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

• Check the wiki for coding guides and troubleshooting for both users and developers.
• Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
• If possible, provide the CemrgApp log file

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in this template. The template will help you explain the problem and include additional details to help maintainers reproduce the problem:

• Use a clear and descriptive title for the issue to identify the problem.
• Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started CemrgApp, e.g. whether you started it from the terminal, or how you started CemrgApp otherwise. Explain how you got to the error. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut, and if so which one?
• Provide specific examples to demonstrate the steps.
• Describe the behaviour you observed after following the steps and point out what exactly is the problem with that behaviour.
• Explain which behaviour you expected to see instead and why.

Provide more context by answering these questions:

• Did the problem start happening recently or was this always a problem?
• If the problem started happening recently, can you reproduce the problem in an older version of CemrgApp? What's the most recent version in which the problem doesn't happen? You can download older versions of CemrgApp from the releases page.
• Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

• Which version of CemrgApp are you using?
• What's the name and version of the OS you're using?

How do I submit a Great Bug Report?

After doing everything in the previous list, if you want to provide additional information, you could follow some of the following:

• Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
• If you're reporting that CemrgApp crashed, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in Console.app under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
• If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.