How to Write a Bug Report
When you find a bug in ILIAS, you should always create a new bug report in our bugtracker Mantis. Only through this report, the developer learns about the issue and can fix it. Hence, it is important to create bug reports that are clear and comprehensible.
Hint for all official testers: Bugs that you encounter during our official testing phase should always be pushed to Mantis from within TestRail. Instructions on how to do so can be found at the end of the page TestRail for Testers. Please also read the following remarks on how to create proper bug reports.
When creating bug reports, please take into consideration the following pointers:
- Choose the correct project and category: For our testing phase, ILIAS core is the correct project. The categories are coherent with the name of our Test Suites, e.g. "File", "Test & Assessment", "Survey" and so on. Normally, this is the correct category, unless you are testing a general service and have encountered issues that are relevant to other categories.
- When creating a bug report from TestRail, this (and the following) data can only be selected after clicking on the "Push" button. Please be sure to check whether the category is correct!
- Is it possible to reproduce the error? Some bugs only happen occasionally. In these cases, please choose the entry sometimes under Reproducibility. If you can easily reproduce the error, please choose always.
- Define the severity: Define how severe the bug is. An explanation of all possible severities can be found in our Cheat Sheet: : Severity in Mantis.
- All bugs are important: The option Priority is set to normal by standard. It shouldn’t be changed during testing. If you are an institutional member of ILIAS Society, it is of course possible to prioritise your bug as usual.
- Choose the correct version of ILIAS: Our bugtracker is being used for all versions of ILIAS, including older versions that are still being used productively. Hence, it is important to choose the correct release number under Product Version. The version can be found in the footer of each pahe in ILIAS, e.g: powered by ILIAS (v 5.3.0 Alpha). If you are pushing a bug report from TestRail, you don’t have to choose the product version!
- Add a helpful title: The text field Summary serves as a title of the bug in Mantis. It's helpful to create a short summary of the issue in order to identifiy it more easily. As the issues are ordered by module, it’s not necessary to add information on the module here. Rather, explain what is happening - or not happening, depending on the issue. When pushing a bug report from TestRail, this field will automatically contain the following text: "Failed test: NAME OF TEST CASE". This information should be changed or amended whenever required.
- How did the error occur? In order to help the developer to find the cause of an error, he often needs to reproduce it.
- Explain what happened under Description.
- Add all necessary steps to reproduce the bug under Steps to Reproduce. Apart from entering text, you can also upload a video.
- If you would like to add further information, feel free to use the field Additional Information.
- When pushing a bug from TestRail, only the field Description is shown to you. There, you can enter the step of the test case where the bug happened. All pushed bug reports contain a link back to the original test case in TestRail so that it's easy for the developer to reproduce the bug. Hence, reporting a bug from TestRail is easier and faster for both parties involved.
- Where can the bug be seen or reproduced? As you are testing ILIAS on the official test platform, please include a link to the object where the error happened. Do not copy the link from your browser navigation bar, but rather use the permalink that can be found in the footer of most pages in ILIAS. If you cannot find the link, include the name of the installation, object and tab.
- Screenshots help to understand the bug: Before writing a long report, think about whether it’s easier to explain your issue by adding a screenshot. This can be done by using the upload dialog in Mantis under Upload File. Please be sure to only upload screenshots in web formats like JPG or PNG. Adding PDFs or Word documents is often tedious for the developers and fellow testers.
- TestRail also allows you to add files and images to a report, but these files unfortunately do not get pushed to Mantis. In consequence, please refrain from adding screens in TestRail. If necessary, it is always better to add the screenshot directly in Mantis.
- Only report the same bug once! If one and the same bug occurs at different stages of your testing process, please only report it ONCE. If you would like to add further information, open the existing bug report and add a note. Adding the same issue in several reports only slows down our maintainers and will result in delays.
- Save your bug report by clicking on the Submit (TestRail) or Submit Report (Mantis) button.