Bugtracking

From TUTOS

(Redirected from Bug show)

Introduction

I don't care what anybody says. I don't care for fancy talks by great marketing people. Once you've programmed you know that bugs are an unfortunate part of everyday life including programs. That said one point has to be made. TUTOS usually contains very few bugs and the ones that do exist are often easily found and corrected. This has for a big part to do with the open source nature of the project since many skilled reviewers make finding and fixing bugs a lot easier than with a closed source program.

When you are ready to install your product you are pretty confident that it is actually pretty perfect all and by itself. But then the first customer calls and he has found a bug, like it or not. Thankfully TUTOS has the ability to take note of bugs, dispatch them to someone to handle and of course you are able to book time spent on finding and fixing bugs. There is an email system informing you of what's going on in this section and it does keep track of the complete bugreport history. Curious? Well let's start then.

Create

The 'bug create' option (actually you don't create a bug but a bugreport) can be reached in many ways. One such method is via the project details screen we saw earlier. There you will see a 'bug create' option in the upper left part of the menu. Clicking on this link will bring you to a screen similar to the one you see in the next picture.

The bugreport creation screen

As you can see there is a lot of information already filled in. Every bugreport has its own unique identification number (how this number is generated is something the TUTOS administrator can set up). In this screen you can enter a short description of the problem. Make sure this is short and informative to all. Furthermore you can set the class of the bug. Is it a light, heavy, dangerous bug or merely a suggestion (feature request). The biggest part of the screen is reserved to enter as much information as possible. For now we will say that we have a light bug because we are out of staples and this has negative impact on the documentation project. We enter the information into the screen and click on the Enter button.

The filled in bug creation screen

After clicking on the Enter button we are presented with the following screen. As you can see, TUTOS informs us that it is incapable of sending an email to user Linux B Torvalds about the entered bugreport. Although this is the first time we see an error message in the TUTOS system please take note of it. As you work more with the system you will see them more often when you do something the wrong way.

The result

As you can see all the information is in place and you can even book time spent on this bug so far. So let's book 1 hour and continue by modifying this bug in the next section.


Modify

Now that we have a bugreport it so happens that we have this intern we can send out to get some staples. So we add this information to the bugreport. First we click on the 'Modify' link in the upper left part of the menu and add the information as can be seen in the next picture.

The bugreport screen

As you can see I have reassigned this bugreport to out intern (who happens to be a Bill Gates) and made a remark of it in the bugreport. It is also possible at this stage to enter the state of this bugreport. There are several options to choose from:

  • OPEN: The bugreport is in an open state. Someone has to start working on it.
  • IN PROGRESS: Someone has started working on it.
  • SOLVED: The bug has been solved but is not yet archived.
  • CLOSED: No work will be done on this bug and it is archived for future reference

We leave the state as it is for now. When we click on the 'Enter' button we are presented with the new bugreport.

The changed bugreport screen

Don't worry about the order in which these entries are displayed. My guess is that will change soon.

Display

To display a list of bugs we start by clicking on the 'Bug Tracking' option in the main menu. This will bring is to a search screen where we can choose to enter a new bug (using the 'new' option in the upper left part of the menu) or search (or do an extended search) for already stored bugreports. Both screens are shown here.

The bugreport search screen

The bugreport extended search screen

As you can see in the extended search screen, it is very easy to search for all the bugreports assigned to the current user or who have a particular state. The example here will also show two custom search fields which are not part of the default.

When we simply click on the search button without entering additional information we are presented with a list of stored bugreports as shown in the next picture.

The bugreport list screen

As you can see there are a number of columns with information. Coincidentally the first column now shows both methods of tagging individual bugreports. One is the method where every bugreport gets a consecutive number. The second method is more customizable and currently is set to use the current date (year and month) and a unique sequence number. Clicking on the id number will get you to bugreport details screen (where you could optionally choose to 'modify' it). Clicking on the reference will get you to the related project (or installation for that matter).

As you can see there is also the familiar set of checkboxes to the right with which you can change a number of bugreports simultaneously. Note that there is no checkbox in the second row because we reassigned that one to user Bill Gates. The actions you can do with the marked bugreports are the following:

  • do nothing: well, er.. how do I explain this one...?
  • Delete: Delete this bugreport from the system.
  • set Class to light: to set the class of this bug to light.
  • set Class to heavy: to set the class of this bug to heavy.
  • set Class to dangerous: to set the class of this bug to dangerous.
  • set Class to suggestion: to set the class of this bug to suggestion.
  • set State to OPEN: to set the state of this bug to open.
  • set State to IN PROGRESS: to set the state of this bug to in progress.
  • set State to SOLVED: to set the state of this bug to solved.
  • set State to CLOSED: to set the state of this bug to closed.

After selecting the required action click on the 'OK' button to confirm. After doing the work requested you are brought back to this screen.

Delete

TUTOS will only allow the deletion of bugs if the administrator has enabled this feature. This is a feature of the program since old bugreports can help tremendously in fixing new ones by preventing some poor technician from
The confirmation screen

'reinventing the wheel'. If it is possible to delete a bugreport you first go to the bugreport detail screen (or the bugreport list where you can select 'delete' as one of the possible actions). Clicl on 'modify' to change the bugreport and next click on the 'delete' option in the upper left part of the menu. The usual confirmation message is shown which you can confirm or deny.


As far as I can tell that is about all there is to say about the bugreport feature of TUTOS. Tell me, did I exaggerate in the beginning when I said that is was a complete module with lots of handy features? If your answer is 'no' I am really looking forward to your email to the developers describing what you like to have added to the program to answer to your needs.

Overview & Search

The search and overview pages allows you to have an overview and some statistics on the issues that will be interessting for youeasy search

Tips & Tricks

Installation

This article will give you the hints how to install, maintain and customize the bugtracking module