Writing a Bug Report
In order to better understand bugs that are reported to us, we hope this short guide will demonstrate the sort of information that will be helpful for us to track down or reproduce your issue. The main points to remember when writing a bug are:
- Information is concise
- Steps provided are reproducible
Below, we will use an achievement issue as the bug example. The issue will be based around the achievement “2,000 volts”, the criteria to unlock this achievement is “Complete all optional objectives on ‘Death Row’’”.
Clear description of the issue:
After completing the prison story ‘Death Row’, the achievement ‘2,000 volts’ was not rewarded. I completed all of the objectives in the To Do list as they were assigned to me, however when I finished the level the achievement was not awarded.
I have completed all of the prison stories and have returned to each of them to complete the optional objectives. ‘Death Row’ was the first I attempted and realised the achievement did not pop and I thought it would be best to raise this with you rather than continuing.
I have been playing prison architect mode, sharing maps and playing other users maps before returning to the prison stories to complete it for the first time.
In the three paragraphs above, each one provides useful information to our developers and QA team to decipher what could be the problem.
- Paragraph one explains the issue and how you came about it.
- Paragraph two explains how you tried to circumvent the issue.
- Paragraph three provides additional information that may have interfered with your game progress.
If any video or screenshots can be provided, feel free to attach a URL to your video or screenshots, if it is useful or relevant.
Reproducible steps:
1. Load Prison Architect.
2. Select Prison Stories.
3. Select ‘Death Row’.
4. Complete every objective.
5. Observe upon completing the prison story and returning to the story selection screen, no achievement is awarded.
What our team will do with this information
With the information above, our QA team will attempt to reproduce your issue by starting the campaign with no optional objectives completed then they will start playing prison warden maps and some shared prison as these maps block of some achievements from being awarded too easily. They will then return to the campaign and attempt to get the achievement, if it is awarded they know there will be other steps involved, if it was not awarded then the information you have provided has saved our team a lot of time investigating.
