Reporting a bug

Wiki ▸ Conventions ▸ General ▸ Reporting a bug

Found a bug 🐛?

When you have a new bug to report, first look at our current issues and make sure the bug hasn't been reported already.

If there is no issue covering your bug, then follow these steps:

1. From this page, start by creating a new issue.
2. Give it an appropriate title, starting with the word BUG: , and a short description of the problem you encountered.
3. Write a verbose comment, explaining the following key points:
   • Bug Description -> describe in detail the problem you are experiencing;
   • Intended Behaviour -> write what you think the intended course of action would be;
   • How to reproduce the bug -> provide a detailed list of steps needed in order to reproduce what you are experiencing;
   • Potential fixes -> write what you think would be a correct approach to solve this issue.
4. Assign the label of Bug 🐜.
5. Assign the correct project.
6. Submit the issue.

Bug Report Template

Bug Description

A verbose description of the bug...

Intended Behavior

What should happen instead...

How to reproduce the bug

This is how to reproduce the bug...

1. first step;
2. second step; etc...

Note: It would be useful if you included pictures as well.

Potential Fixes

Ideas on what could be implemented to solve the issue.

Example

Bug Description

When creating a user via the POST method on /users/ endpoint, all the roles provided in the body's list are being overwritten.

Intended Behaviour

When a new user, is being created, it should only use the valid roles from the provided list without overwriting their values and ignoring the invalid ones.

How to reproduce the bug

1. Create a POST request on /users/.
2. Provide a role using only its ID ( without specifying the name ).
3. It will overwrite the actual role to the one provided in the list, thus changing its name property to null.

Potential Fixes

When creating the user, it would be possible to check for the existence of each role by id ( ignoring the value received as the name ), retrieve all of the existing roles in a list, and assign this newly created list to the user entry we are about to make.