Writing Bug Reports

[Imperial Knight]

When writing a bug/defect report, please be sure to read through this guide so that we can best assist you and solve the issue faster.

Bad Bug Reports​

Examples of a bad bug report:

1. "It's not working" - What's not working?
2. Only a screenshot/video provided with no description of the issue - What in the video or screenshot went wrong & what were you expecting?
3. No reproduction steps provided - How can we reproduce the issue without understanding what caused it?
4. "Fix <issue here>" - Does not tell us about the issue, only that it exists for you. We need more details.
5. Mentioning a feature change/request as a bug/defect. Note that bugs/defects are only intentional flaws, meaning something is not working as designed. If you want to change the design, that would be a suggestion/feature request. This is important for us to distinguish between important issues and those that are gameplay preferences.
   1. Example of a bug/defect: Laundry system on HL2RP won't turn wet laundry into dry laundry when going through the dryer
   2. Example of a feature/change request (not bug/defect): Laundry system should make folding easier by not requiring the E key

Good Bug Reports​

When writing a good bug report, include the following information:

1. Reproduction steps - What specific steps or scenario was undertaken that resulted in the defect?
   1. Many times what you think is a simple or direct bug actually only happens under specific circumstances. If we can't figure these out, we have no way to solve the issue you've reported other than guessing while testing, which takes a lot more time to solve the issue.
2. Expected outcome vs outcome received. Describe what outcome you were expecting and what happened instead.
3. Screenshots/videos of the issue happening, including the steps leading up to it if possible.
4. When and where the issue happened.
   1. This is crucial - for example we have 3 servers for our HL2RP: Main, Test, & Development. These can be running different versions and servers may have been updated after the issue you're reporting. Providing where and when let's us narrow these down and saves a lot of time.

If you wish, you can use the following template when submitting bugs to us which covers the details above. Additionally, if your submission does not satisfy the above requirements we may ask you to fill out this template:

1. Description of the bug:
2. Steps to reproduce the bug:
3. Expected outcome vs outcome received:
4. Where and when the bug happened:
5. Screenshots/videos of the issue happening: