title(Bug/Feature Request/Patch Information Guideline)

Introduction

The NetarchiveSuite bug/feature-request/patch registration is done by trackers in GForge (https://gforge.statsbiblioteket.dk/tracker/?group_id=7)

The trackers are explain in three different ways:

via the tracker reporting process
via overview of fields for different trackers
via description of all fields that can appear in any tracker

this includes explanation of field, description of possible values and default values There are some differences between order of fields to be set for bugs, feature requests and patches respectively. Furthermore it may be that some of the fields are not included in all trackers. In the following these will be marked as: Values are marked with

(not for bugs) if the field is not included in bug trackers
(not for feature requests) if the field is not included in feature request trackers
(not for patches) if the field is not included in patch trackers

Nothing is indicated the field in included for all trackers.

There are also differences in possible values in drop downs for the different trackers. Values are marked with

(bugs only) if it only concerns bug trackers
(feature requests only) if it only concerns feature request trackers
(patches only) if it only concerns patch trackers

Nothing is indicated if the values are possible for all trackers.

Tracker (bug/feature-request/patch) reporting process

time when information should be updated

Overview of fields for different trackers

Display and editability of fields depends on whether you have a login to GForge. Therefore the overview is given for both cases.

Overview for users logged on GForge

For each tracker following is noted per field:

[new] if the field can be edited at the creation time of the tracker
[edit] if the field can be edited in updates of the tracker
[auto] if the field is automatically set by the system without possibility to change it
[locked] if the field is locked for a person not logged into GForge
- if not present

Tracker fields description

In this section all fields that can appear in a bug/feature-request/patch (from here called tracker) is listed and explained. The fields are listed in alphabetic order.

Assigned To: [new, edit]

The person the tracker is assigned to. That means it is this person that will be responsible for next action on the tracker (except from points where QA needs to take action). A tracker can be assigned to a person either via the module specification which each has a responsible person. Or it can be assigned by the person themselfes, in case they want to take it, or it can be reassigned by the allready assigned person or QA.

Nobody in case the tracker is not assign to anybody (default value)
The <name> of the person that the bug/enhancement is assign to

Attach Files: [new, edit]

This field offers functionality to add attached files to the list of files under the 'Existing Files' field.

Change Log:

Log of changes already made to the tracker.

Data Type: [edit]

The data type tells whether it is a bug, a feature request or a patch. For new bugs/feature-requests/patches, it is automatically set to the selected tracker

Bugs for bugs
Feature Requests for feature requests
Patches for patches with code sent NetarchiveSuite for inclusion

NOTE: if the data type is changed, there may be some of the values that are not transferred to the new tracker type. These values need to be set again.

Date Submitted:

The date when the tracker was submitted is automatically set and given on form YYYY-MM-DD HH:MM.

Detailed description: [new, edit]

The detailed description adds information as basis for planning and doing resolution of the tracker. This information must be provided as detailed as possible at the time of registering the tracker. Furthermore it is used to add information at later stages. Additional comments must be entered via the 'OR Attach A Comment' field and they will then appear in the 'Followup' field.

The detailed description must include

a detailed description of what the tracker is about
possible resolutions if known
estimated time for fixing in case the Keywords field includes setting of the ESTIMATED keyword.

Duplicate Of: [new, edit] (not for patches)

If the tracker is a duplicate then the number of the tracker that it is a duplicate of is written here. The status must then be set to Duplicate.

Existing Files:

List of files already attached to the tracker.

Followup:

List of additional comments to 'Detailed description' of the tracker. See also explanation of the 'Detailed Description' field.

For project:

The project field in this context is automatically set to NetarchiveSuite.

Module: [new, edit]

This module field must be set in order to have the tracker directed to the correct tracker owner.

None BR if not set (which it must be before it is assigned to a person) (default value)
Access BR if it concerns the Access (viewerproxy) module
Archive BR if it concerns the Archive module
Common BR if it concerns the Common module
Deploy BR if it concerns the Deploy module
Documentation BR if it concerns the documentation related to NetarchiveSuite
Harvester BR if it concerns the Harvester module
Monitor BR if it concerns monitoring [TODO: must be better described]
Test BR if it concerns the test of NetarchiveSuite

OR Attach A Comment: [edit]

This field is used to enter additional comments to the 'Detailed description' field.

Priority: [new, edit]

The priority can only be changed by QA in cooperation with the daily production manager. The priority is basis for planning resolution order of tracker and which procedures can be used in order to have fixes quickly patched into the production environment.

Priority 5 (highest): Must be fixed as a patch in current stable release.
Priority 4 : Much be fixed in next stable release.
Priority 3 : Should be fixed in next stable release. (Default value)
Priority 2 : Not planned in next stable release.
Priority 1 (lowest): Not expected to be fixed.

Status: [new, edit]

The status tells where the tracker is in the implementation process, thus it must be set during process of implementation of the tracker.

Resolution values for bugs and feature requests which must be set during process of treating the tracker

New BR if new and not set (Default value)
Need Info BR The tracker needs additional informaiton before it can be evaluated. Informaiton about what sort of information is needed must be noted in the 'Detailed description' field or in the 'Followup' field (via 'OR Attach A Comment')
Evaluated BR if the tracker is evaluated for when the tracker can be implemented. For bugs and feature requests an estimate must be made as preparation for prioritisation. This estimate must be noted in the 'Detailed description' field or in the 'Followup' field (via 'OR Attach A Comment'). For patches the result of the evaluation must be noted in the 'Detailed description' field or in the 'Followup' field (via 'OR Attach A Comment').
In progress BR if the tracker is being implemented. That means the process of programming, documentation, unit test development and code reviews has started and no other developer should interfear without coordinating first.
Fixed BR if the tracker is implemented with source and unit tests checked into GForge, and after sanity test and code review. Note that the description of how it is implemented and check e.g. in unit test must be noted in the 'Detailed description' field or in the 'Followup' field (via 'OR Attach A Comment').
Fixed, Passed QA BR if QA has accepted the tracker as fixed/implemented. Only QA must change to this status. Before a release test all trackers included must have this status before the release test can start.
Fixed, Released BR if the tracker has been release tested and the implementation is part of a stable release.
Duplicate BR if the tracker was already registered and therefore are duplicate of another tracker. The duplicate tracker number must then be noted in the 'Duplicate Of' field.
Invalid BR if the tracker is not valid as a bug or feature request, e.g. if it was caused by wrong use of the system
Won’t fix BR if it is decided not to implement the tracker ever, for instance if the behavior described in a bug is the intended behavior of the system or if a patch is not to be included. A reason for this status must be noted in the Detailed description' field or in the 'Followup' field (via 'OR Attach A Comment').

Submitted By:

The initials of the person which the tracker is submitted by are automatically set.

Summary: [new, edit]

The summary consists of a short description of the tracker. The summary is used when an overview of tracker is made. This information must be provided when the tracker is registered.

Use Canned Response: [edit]

This field is not used at the moment, and thus should never be set.

Version: [new, edit]

The version field is only used, when it is critical in order to understand the tracker or reproduce a bug. Version of code that the tracker relates to. This means that it must be set for patches, since these will include code that need to be compatible with the rest of the code.

Default is None.

[TODO: We need to find out whether this field should be used more extensively, and what the rules then are for trackers found at reviews, in test, in production, in Scotland or somewhere else]