Post by Daniel Everland on Aug 15, 2019 15:59:03 GMT 1
Internal Bug Report Example
I figured some of you highly active might be interested in seeing exactly what happens when we've added your bugs to our internal bug tracker JIRA. The following report was generated from a genuine user report and hasn't been altered in any way. I hope this insight might help you guys create even better bug reports for us in the future!
The title is merely intended to let us know at a quick glance what the bug is about. It doesn't have to contain all the information, in this case I've chosen to not mention that you have to re-enter edit play mode for instance.
Steps to Reproduce
These will probably look quite familiar to most of you. Actions the user has to take are numbered, which allows us to refer to previous steps easily. When the person reproducing the issue has to observe something, we indicate it using the > character. Also note that in this case I've named the two different teams Team A and Team B, this allows us to easily reference them later in the report. We often do the same for multiplayer related issues by naming each user in the project.
This is the person who has to fix the issue. I just reported this so no-one has been assigned to it yet
The person who wrote the initial report, in this case that's me
When a dev has fixed the issue QA has to know which server to test the fix on. This field is unassigned since the issue hasn't been fixed yet
What servers have I verified the issue exists on? Note that we don't have to test every single server, we often only reproduce issues on Friends and WWW
This you're surely familiar with, it simply states what build target the bug was reproduced with.
The first 3 digits in the version number. This can be found using /build in the chat or by looking at the log file
We often want to find all issues pertaining to a certain feature, so we name our releases. If we then want to find all the issues we have yet to fix on classes we can easily write a simple
query to do so in JIRA
Same as Introduced In, but instead shows the name of the release the issue has been fixed in
How severe is this issue? In this case I've selected Minor because it has quite a few steps and only exists in edit mode. The options are: Trivial, Minor, Major, Critical and Blocker
We almost always include attachments such as GIFs, screenshots or log files, depending on the issue. In this case I've included the following GIF, which shows how I reproduced the issue. This is often useful to devs if they don't fully understand Steps to Reproduce