Jump to content

[Guide] How to Report a Script Bug


Eliot

Recommended Posts

Overview:

Many users are unaware of how to properly submit bug reports, a vital communication tool between users and scripters. Bug reports provide scripters with the information they need to fix bugs and issues in their scripts. I've decided to create this short guide to teach everyone how to submit an effective bug report to ensure minimal downtime of their favorite scripts. This guide may seem obvious to some, but it has become evident it is necessary. 

 

Before Submitting Report:

Before even submitting the bug report, make sure the following statements apply to you completely.

  • I am exactly following the scripts instructions.
  • I am using the newest version of the script (if local download).
  • I am using the newest version of the OSBot client.
  • I am using the newest version of Java.
  • I am NOT using low CPU mode.

If and only if you answered yes to all of the above questions should you submit a bug report.

 

Do not submit a report about anything related to random events, these are not controlled by the script.

 

What to Include in Report:

Include at a minimum the following in your bug report:

  • Client version
  • Script version
  • Date
  • Low CPU mode?
  • What caused the bug to occur/when did the bug occur?
  • Where was the character when the bug occurred?
  • Screenshot (if applicable)

Providing all of the above information will allow the scripter to quickly assess the issue and fix the bug. Do not post anything vague in your report as this only leads to confusion.

 

Where to Submit Report:

When submitting your bug report either post it in the script's thread or send the script writer a private message. Posting a bug report anywhere else is entirely useless.

 

Example Template:

Client Version:
Script Version:
Date:
Low CPU Mode (yes/no):
Bug Description:
Bug Occurs When:
Where Bug Occurs:
Screenshots (if applicable): 

Examples of Good Reports:

Client Version: 1.76
Script Version: 2.0
Date: February 1, 2014
Low CPU Mode (yes/no): No
Bug Description: The bot will attempt to attack guards already being attacked by other players.
Bug Occurs When: The bug occurs whenever the bot is fighting
Where Bug Occurs: The bug occurs in Varrock near the guards.
Screenshots (if applicable): *Useful Screenshot* 
Client Version: 1.71
Script Version: 3.2
Date: February 12, 2014
Low CPU Mode (yes/no): No
Bug Description: Bot does not climb down ladder
Bug Occurs When: Standing in front of the ladder.
Where Bug Occurs: Occurs in front of Taverly Dungeon ladder.
Screenshots (if applicable): *Screenshot of location*  

 

Examples of Bad Reports:

 

lel wtf this bot sux so buggy L0l omg

 

bot sux doesnt wurk

 

Combat doesn't work right, everything is all messed up, please fix!

 

shit script dunt even work

 

Thank you for following this guide, Eliot and the OSBot scripters thank you!

Edited by Eliot
  • Like 2
Link to comment
Share on other sites

Guest
This topic is now closed to further replies.
  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...