Arrow Home arrow Forums
larger font smaller font default font Fixed screen resolution Auto adjust screen size

Joomlapolis Forums  


[READ BEFORE POSTING] Reporting bugs: Howto
Date: 2006/08/26 16:35 By: beat Status: Admin  
Karma: 238  
Admin

Posts: 3995
graphgraph
How to report bugs effectively...saw today this excellent summary of a long article:

Summary from Simon Tatham, professional and free-software programmer:

Summary


  1. The first aim of a bug report is to let the programmer see the failure with their own eyes. If you can't be with them to make it fail in front of them, give them detailed instructions so that they can make it fail for themselves.

  2. In case the first aim doesn't succeed, and the programmer can't see it failing themselves, the second aim of a bug report is to describe what went wrong. Describe everything in detail. State what you saw, and also state what you expected to see. Write down the error messages, especially if they have numbers in.

  3. When your computer does something unexpected, freeze. Do nothing until you're calm, and don't do anything that you think might be dangerous.

  4. By all means try to diagnose the fault yourself if you think you can, but if you do, you should still report the symptoms as well.

  5. Be ready to provide extra information if the programmer needs it. If they didn't need it, they wouldn't be asking for it. They aren't being deliberately awkward. Have version numbers at your fingertips, because they will probably be needed.

  6. Write clearly. Say what you mean, and make sure it can't be misinterpreted.

  7. Above all, be precise. Programmers like precision.



Post edited by: beat, at: 2006/12/15 14:38

Post edited by: beat, at: 2007/10/03 10:30
Beat - Developer on Community Builder core Team
- If you like CB and this forum, you will love Nick's CB 1.1 reference manual ! : Click here to Get it now
- Would like to help us move faster ? Get it, and/or help us spend more time coding by helping others in this forum, many thanks
Click here to see the profile of this user The topic has been locked.

Documentation

Documentation Subscription Service
(updated for CB 1.2 RC2)

What?

Why?

Where?

Just click here for answers!

Click here for a yearly subscription: subscribe now

Download Latest Release

The latest stable Community Builder Release is version 1.1 for Joomla 1.0 and Mambo.
You need to be a registered member of Joomlapolis to download.

The latest release candidate of Community Builder is version 1.2 RC3, native for Joomla 1.0, 1.5 and Mambo.
It is available as "thank you" to all CB documentation subscribers at this time.

CB Login