Guide to Posting GOOD Bug Reports.

**Chris!** · 01-21-2013, 02:57 AM

Welcome to the Guide to Posting GOOD Bug Reports!

Foreword:

The new bug reporting system has made it much easier for developers and staff to be alerted of bugs or issues with anything to do with SRL, whether it be for the forum or the SRL include. Here, in this guide, I will show you how to help the staff fully understand what is happening so they can address the problem.

Table of Contents:

Introduction:

Hello SRL. This guide was written to help you help the staff with bugs that you have found while browsing the forum, scripting, etc.

What is this Bug Reporting System you speak of?:

I'm glad you asked. Well, simply put it's a fast, simple way for you to contact the staff about an issue without posting on the forum. It uses a posting system similar to a ticket system.

Using the Feature:

Alright, so now you know what it is. Now you need to know how to use it. First of all, go to the Bugs page. You can click the "Bugs" button in the Navigation Bar or you can go to this link: http://villavu.com/forum/project.php.

Home Screen:

Now, you should now see this screen:

There are three sections that you may post an issue in, these are:

Site Bugs - Bugs related to the website.
SRL 5 - Bugs related to the SRL 5 include.
SRL 6 - Bugs related to the SRL 6 include.

Below this you will see the "Timeline" which shows the latest issues reported.

Under the Navigation Bar, you will see the following links:

My Reports - You can view the reports you have submitted here.
Manage Subscriptions - You can view the issues you have subscribed to here.
Project Timeline - You can view all issues posted here.
FAQ - FAQ for the feature. Not done yet.

Posting a Bug:

So you have a bug you want to report, eh? Good. First of all go to the section which applies to your bug:

Bug - Found a bug? These go in here?
Feature - Suggestions go in here.
Task - Having a problem with a task? That goes in here.

Now you should see an assortment of posts about the place the bug happened (website, SRL):

Click the "Post New Issue" button:

You will see the following dropdown box:

Click the option that applies to you.

Now, you should see the same old layout you're used to with posting:

Now in the following section I will tell you how to provide GOOD information with examples of what not to do.

Submitting a Good Report:

The difference in submitting a good report and submitting a bad report is this. A good report will have the problem fixed as soon as the staff know. A bad report will have the staff asking questions about it and not being able to fix it until you give all these details. I will be using a reputation bug as an example for these.

Title:

A title should allow a staff member to look at it and know roughly what it's about.

GOOD title:

BAD title:

Summary:

A summary should basically be a too lazy; didn't read for your bug. A shortened version of what you're explaining in the body.

GOOD summary:

BAD summary:

Body:

This is the most important thing about submitting a bug. Go into as much detail as you can in this section about how to get the bug to happen, what happens with the bug, where the bug occurs, etc.

GOOD body:

BAD body:

Priority:

You can give the issue you post a priority rating (0-10). 0 being unknown priority, 1 being highest and 10 being the lowest.

You can find the priority box below the body text box.

Be serious about the rating you give it.

Author's Note:

Thank you for reading this guide and I hope it helped you. If you find any grammatical issues in any part of this thread, PLEASE alert me too it! You can help make the guides better by doing this and suggesting things to add to the guide!

Back To Top

Thanks!

-Chris!