Reporting a bug - best practices
We have streamlined the bug reporting process, so here's a step-by-step guide to reporting one!
We have streamlined the bug reporting process, so here's a step-by-step guide to reporting one!
Make sure you have a GitHub account. If not, simply email ktechindustries2019@gmail.com and skip these steps.
Navigate to the issues section under our repository.
Click the "New Issue" button to create a new issue.
What are issues? Well, issues are our way of keeping track of what's going on, and what's needed. When you click "New issue", you are creating a new issue request under your account. The issue is given a name and number so developers can tag "Fixed #455 causing app to crash" when solving issues.
Upon clicking "New issue":
You will be prompted to report a bug or request a feature.
Since we are reporting a bug, select "Get Started" under the "Report a bug with MPRUN" section.
You might be a little confused what exactly you are editing. This is a common text format called Markdown.
<!-- READ THIS FIRST:
- Make sure you are running the latest version of MPRUN before reporting an issue: https://github.com/ktechhydle/mprun_repo/releases
- Provide as many details as possible if you are developing. Paste logs, configuration samples and/or code into the backticks.
- If you are user, thanks for using MPRUN. You can still use these instructions, just skip over developer related stuff.
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
-->
## The problem
<!--
Describe the issue you are experiencing here to communicate to the developers.
Tell us what you were trying to do and what happened instead.
-->
I tried too... It crashed when I...
## Environment
<!--
Provide details about the versions you are using, which helps us to reproduce
and find the issue quickly.
-->
- MPRUN release with the issue: <YOUR VERSION HERE>
- Operating environment (Windows or MacOS): <YOUR OPERATING SYSTEM HERE>
## Traceback/Error logs
<!--
If you come across any error dialogs, please provide them.
-->
```shell
```
## Additional information
<!--
This is optional.
-->
If you don't know how markdown works, that's completely fine! Please see here. The instructions inside the markdown text can help you create the issue.
After you have successfully created and submitted an issue, developers will evaluate your issue and eventually fix it. We try to get to issues as fast as possible, but sometimes it can take a little extra time. If you tag your issue under "IMPORTANT" we will fix it as soon as possible.