Results 1 to 10 of 10

Thread: Guide to Posting GOOD Bug Reports.

  1. #1
    Join Date
    Sep 2012
    Location
    Australia.
    Posts
    839
    Mentioned
    16 Post(s)
    Quoted
    225 Post(s)

    Thumbs up Guide to Posting GOOD Bug Reports.

    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:





    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!
    Last edited by Chris!; 01-21-2013 at 03:03 AM.

  2. #2
    Join Date
    Mar 2007
    Posts
    5,125
    Mentioned
    275 Post(s)
    Quoted
    901 Post(s)

    Default

    Fantastic guide Chris!
    Last edited by Justin; 01-21-2013 at 03:10 AM.

    Forum account issues? Please send me a PM

  3. #3
    Join Date
    Jun 2012
    Posts
    4,867
    Mentioned
    74 Post(s)
    Quoted
    1663 Post(s)

    Default

    Another great guide, Thanks Chris!

  4. #4
    Join Date
    Dec 2011
    Location
    Hyrule
    Posts
    8,662
    Mentioned
    179 Post(s)
    Quoted
    1870 Post(s)

  5. #5
    Join Date
    Mar 2012
    Location
    Canada
    Posts
    442
    Mentioned
    4 Post(s)
    Quoted
    67 Post(s)

    Default

    good guide

  6. #6
    Join Date
    Jan 2012
    Location
    Calgary, AB, Canada
    Posts
    1,819
    Mentioned
    5 Post(s)
    Quoted
    120 Post(s)

    Default

    Very nice guide Chris!
    Current Project: Retired

  7. #7
    Join Date
    Mar 2006
    Location
    Belgium
    Posts
    3,564
    Mentioned
    111 Post(s)
    Quoted
    1475 Post(s)

    Default

    Nice tutsie

    Creds to DannyRS for this wonderful sig!

  8. #8
    Join Date
    Jan 2007
    Posts
    8,876
    Mentioned
    123 Post(s)
    Quoted
    327 Post(s)

    Default

    You just keep on giving... Good job!

    E: Or perhaps I should say "pro totoriel, man" instead

  9. #9
    Join Date
    Oct 2008
    Location
    C:\Simba\Includes\
    Posts
    7,566
    Mentioned
    19 Post(s)
    Quoted
    180 Post(s)

    Default

    Another nice guide, keep it up!
    Away for awhile, life is keeping me busy. | Want to get my attention in a thread? @Kyle Undefined; me.
    { MSI Phoenix || SRL Stats Sigs || Paste || Scripts || Quotes || Graphics }

    When posting a bug, please post debug! Help us, help you!

    I would love to change the world, but they won't give me the source code. || To be the best, you've got to beat the rest. || Logic never changes, just the syntax.
    If you PM me with a stupid question or one listed in FAQ, or about a script that is not mine, I will NOT respond.


    SRL is a Library of routines made by the SRL community written for the Program Simba. We produce Scripts for the game Runescape.


  10. #10
    Join Date
    Sep 2012
    Location
    Australia.
    Posts
    839
    Mentioned
    16 Post(s)
    Quoted
    225 Post(s)

    Default

    Quote Originally Posted by Justin View Post
    Fantastic guide Chris!
    Cheers.

    Quote Originally Posted by BMWxi View Post
    Another great guide, Thanks Chris!
    Thanks .

    Quote Originally Posted by Ashaman88 View Post
    Nice job! Was hoping it was how to submit script bug reports :P hehe but still nice
    That could be a guide in the future.

    Quote Originally Posted by kyleinkman View Post
    good guide
    Cheers.

    Quote Originally Posted by Gucci View Post
    Very nice guide Chris!
    Cheers.

    Quote Originally Posted by Sjoekeloe View Post
    Nice tutsie
    Thanks qt3.14

    Quote Originally Posted by Zyt3x View Post
    You just keep on giving... Good job!

    E: Or perhaps I should say "pro totoriel, man" instead
    Hehe. I really hope that catches on! Thanks.

    Quote Originally Posted by Kyle Undefined View Post
    Another nice guide, keep it up!
    Thanks Kyle.

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •