Bug Reporting
From BotHouse MediaWiki
This page is not finished. You can help the StormBot Wiki Team by adding to it.
In order to create the best possible experience for users of StormBot feedback about the script is needed. Due to the fact that StormBot is maintained by people volunteering their time and expertise, submission guidelines have been drafted to cut down on the amount of busy work created in duplicated bug requests.
Users submitting bugs that do not follow these guidelines will immediately be "closed" with a reason of won't fix.
Please submit bugs to the bug tracker as it will publish them to the world and others may search it and find answers to their questions.
[edit] Prior to Submitting
Please make sure the latest version of the StormBot script is being run on the bot in question. Please be aware that updates and new versions are issued regularly as bugs are fixed. It is possible that the issue in question has already been fixed if the version running is older than the current release.
The first, major rule of reporting bugs to the StormBot bug tracker is that previous entries are not duplicated. This means, please use the search methods in order to see if a specific issue has already been addressed in a previous report. Please rigorously search the bug tracker for any viable search terms that would be included in your request. These terms include commands that caused the error, terms inside the output of the bot when the command was issued, etc.
[edit] How to Search
- Click on the View Issues option at the top of the bug tracker page
- There will be a Search box that appears. Type in the search query and click Apply Filter.
- If this does not return any satisfactory matches, click Reset Filter (same line as the search, but on the right side of the page).
- Search again for terms included in your bug report, such as command names that caused the error, etc.
[edit] Reporting a Bug
If you have searched the bug tracker and found no issues with the command name that caused the error or any other relevant information. The next step is to create an account in the bug tracker so that your request can be logged and developers can communicate with you.
[edit] Create an Account
The StormBot bug tracker only allows registered users to submit bugs. This is so that users may be contacted in the event issues cannot easily be resolved or reproduced. It also allows users to immediately receive updates on their issues as soon as the developers log updates to the system.
[edit] Field Information
The bug reporting method has been specifically designed to aide the StormBot developers to pinpoint the location of the reported issue. In order to cut down on the amount of time spent in dissecting the code to find possible problems, it is requested that you fill in as many fields as humanly possible in order to ensure speedy service. An overabundance of information is much better than too little information to rectify the issue.
[edit] Category
Please select the category of the request being placed. If it is a command of a module, when you request help on the command causing the error, it will tell you "Piping into..." If this is the case, select Modules
[edit] Reproducibility
This field would be in the case that an older version of StormBot was being run and also had upgraded to the new version. This does not mean I ran the command twice and it crashed both times. If you have made no changes in order to rectify the issue (upgrading, etc), please select N/A.
[edit] Severity
Despite popular ideals, not every issue is considered major. Issues that crash the bot (meaning it quits from IRC) should be marked as Crash. Issues that affect lots of components or core components should be marked as Major. All other issues should be marked as Minor or below.
[edit] Platform
This is designated to be the platform of the machine running the eggdrop bot, not the user's computer (unless they happen to be the same).
[edit] OS
This is the operating system of the computer running the eggdrop bot. This should be something like:
- Redhat
- Debian
- Ubuntu
- Slackware
- FreeBSD
- NetBSD
- OpenBSD
- Windows
If you are running eggdrop from a shell account, you may try the following command in order to receive the OS version:
uname -s
The specific version of the operating system is destined for the field marked OS Version.
[edit] OS Version
This relates to the machine running eggdrop. If it is a shell account, you may try running the following command from the command line (SSH or Telnet) to find its version number:
uname -r
[edit] Product Version
This is the version of StormBot that has been installed. There are no revisions being done on any version prior to StormBot 5.2. Upgrade if an older version is being used.
[edit] Product Build
StormBot developers release regular updates on http://www.stormbot.net. The product build information is inside the tarball downloaded to install the script. In the example of the file stormbot5.2.release.001g.standard.tar.gz, the Product Build would be 001g.
[edit] Assign To
This is not for you. Leave this field blank.
[edit] Target Version
This is not for you. Leave this field blank.
[edit] Summary
This should include descriptive words about the issue at hand. Examples of Bad summaries:
- It doesn't work
- StormBot sends me an error
- It crashes
Examples of Good summaries:
- Error when using <COMMAND> on <IRCD_VERSION>
[edit] Description
This should contain information about the modules affected by the error and any other pertinent information to the developers. Remember, an overabundance of information is better than not enough information.
[edit] Steps to Reproduce
This is for intuitive users looking to provide additional reproduction information to the developers. This field should include the commands in steps.
[edit] Additional Information
This is for users wishing to add additional information about the bug and potentially its significance.
[edit] Contact Server Address
This is to provide developers with the necessary information to contact a bug reporter online. While the bug tracking system does automatically send emails out to bug reporters, it is not clear whether or not they will be online when developers attempt contact.
[edit] Contact Channel
This is to help provide developers with a point of contact for the bug entry. Be aware that much of the contact had will be through the bug tracker system. This is almost a requirement to document fixes and reasons for bugs existing.
[edit] Contact Nickname
Should a developer need to contact a bug request issuer, this will be the nickname they contact in conjunction with both the Contact Server Address and Contact Channel. This should be the owner of the bot or a user of bot services.
[edit] Private/Lending Service
This field is meant to address those that are borrowing bots so that the owners may be properly contacted. As users who are using a lending service do not have access to thoroughly upgrade the bot it is best to contact the bot's owner.
[edit] Eggdrop Version
This is used to provide the developers with information as to which version of eggdrop is being used. This can be helpful in identifying bugs that exist in the eggdrop code and thus not fixable from a StormBot developer's standpoint.
[edit] TCL Version
This is used to provide developers with the information needed to make sure the TCL libraries are kept up to date and address issues within TCL.
[edit] Command Used to Cause Bug
This is to provide developers a quick overview of what caused the error. This command is used for testing to make sure the bug report is valid. Developers will connect a bot to the specified network and test the command in question to develop a further understanding of the bug.
[edit] Debug All
Please copy and paste the results of <BOT_NICKNAME> DEBUG ALL into this box. The output starts with Debug information for SB5 and ends with > End of DEBUG.
