Issue reporting guidelines¶
To maintain an effective bugfix workflow and make sure issues will be solved in a timely manner we kindly ask reporters to follow some simple guidelines.Before creating an issue, please do the following:
- Check the existing issues to make sure you are not duplicating somebody’s work.
- Make sure, that information you are about to report is a technical issue. For technical questions please refer to:
- If you are sure that the problem you are experiencing is caused by a bug, report here a new issue following the recommendations below.
The following template is a placeholder for every new issue. We request you to follow its sections carefully:
Steps to reproduce
- Screenshots or description
- Screenshots, logs or description
Please note, that higher level of detail in the report increases chance that someone will be able to reproduce the issue. It is hard to advice on any problems which can not be replicated.
Steps to reproduce¶
This part of the bug report is the most important, as developer will use this information to reproduce the issue. Problem is more likely to be fixed if it can be reproduced.
Precisely describe each step you have taken to reproduce the issue. Try to include as much information as possible, sometimes even minor differences can be crucial.
A good example is the following:
- Navigate to the IoT Device Manager as guest
- Choose the City enabler
- Try to add a new Device from the GUI
Expeted and Actual result¶
To make sure that everybody involved in the fix are on the same page, precisely describe the result you expected to get and the result you actually observed after performing the steps.
The device is correctly published
The device is not published and the following error message is prompted: "..."
Additional information is often requested when the bug report is processed, you can save time by providing the Digital Enabler team with browser logs, screenshots and any other information related to the issue that you think may be useful.