title(Bug/enhancement information guideline)

TableOfContents

Introduction

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

In the next section all headers that can appear in a bug/enhancement is listed and explained.

In each header, it is indicated whether it can be set when a new bug/enhancement is created (by [new]) and whether it is editable when information is changed (by [edit]). No indication means that it is information calculated by GForge.

For each header the following information is given, if relevant:

• explanation
• default value
• values it should be set to
• possible values with explanation
• time when information should be updated

Bug Information

For project:

Automatically set to NetarchiveSuite

Submitted By:

Automatically filled out with the person that submitted the bug/enhancement

Date Submitted:

Automatically filled out with the date when the bug/enhancement was submitted (on form YYYY-MM-DD HH:MM)

Data Type: [edit]

Tells whether it is a bug or an enhancement.

For new bugs/enhancements, it is automatically set to the selected tracker

• Bugs for bugs

• Feature Requests for enhancements

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

Hardware: [new, edit]

Not used.

Default is None.

Should always be set to None.

Product: [new, edit]

The product that the bug/enhancement concern.

Default is None.

Should always set to NetarchiveSuite.

Operating System: [new, edit]

Since the NetarchiveSuite is independent on the operating system, this is not an information that is used.

Default is None.

Should always set to All.

Component: [new, edit]

Default is None.

Should always be set to one of the following values

• common if it concerns the NetarchiveSuite common module

• deploy

• documentation

• general

• harvester

• harvestdefinitions

• indexserver

• logicalpreservation

• monitor

• releasetest if it concerns the test description or the test set-up

• scripts

• tools

• viewerproxy if it concerns the NetarchiveSuite viewerproxy module

Version: [new, edit]

Default is None.

Version of code that the bug/enhancement relates to.

Only set when it is important for reproduction of bug or understanding of enhancement.

[Er det rigtigt? Og hvis ikke, hvad så når det er fundet i review? Skal man bare altid tage den seneste? – og hvordan ses så forskel på om den er fundet i produktion, test eller skotland?]

Severity: [new, edit]

Default is None.

• None

• blocker

• critical

• major

• normal

• minor

• trivial

• enhancement

Target Milestone: [new, edit]

Default is None.

Should always set to None.

Resolution: [new, edit]

Default is None.

• None

• Fixed

• Invalid

• Not a bug

• Duplicate

• Won’t fix

• No change

Duplicate Of: [new, edit]

If the bug/enhancement is a duplicate then the <number> of the bug/enhancement that it is a duplicate of is written here.

=== URL: [new, edit] Leave as empty. Not used ????

Keywords: [new, edit]

• None

• ASSIGNMENT

• PRIO_LIST

• ESTIMATED

• PLIGT

• MISSING_REVIEW

• MISSING_UNITTEST

• TRIVIAL

Status: [new, edit]

Default is Open.

• Open

• Closed

• Resolved

• Assigned

• Need Info

Assigned To: [new, edit]

Default is Nobody.

• Nobody in case the bug/enhancement is not assign to anybody

• The <name> of the person that the bug/enhancement is assign to

Priority: [new, edit]

Default is 3.

Normally it will only be the administrator (QA) that changes the priority to one of the following values:

1. lowest

5. highest

Summary: [new, edit]

A short description of the bug/enhancement.

Detailed description: [new, edit]

Describe

• what the bug/enhancement is about
• possible resolutions
• estimated time for fixing

Use Canned Response: [edit]

Not used ???

OR Attach A Comment: [edit]

Extra comments relating to description

Followup:

List of historical description and comments to the bug/enhancement.

Attach Files: [new, edit]

Existing Files:

List of files already attached to the bug/enhancement

Change Log:

Log of changes already made to the bug/enhancement