Fields for different Tracker Issues

edit

All fields that can appear in any tracker issue are explaned including 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 tracker issues.

Overview of fields for different tracker issues

Display and edit ability 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 issue following is noted per field:

• [new] if the field can be edited at the creation time of the tracker issue
• [edit] if the field can be edited in updates of the tracker issue
• [auto] if the field is automatically set by the system without possibility to change it
• - if not present

Overview for users NOT logged on GForge

For each tracker issue following is noted per field:

• [editable] if the field can be edited
• [locked] if the field is locked for a person not logged into GForge
• - if not present

Fields description

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

Assigned To: [new, edit]

The person the tracker issue is assigned to. That means it is this person that will be responsible for next action on the tracker issue (except from points where QA needs to take action). A tracker issue 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 themselves, in case they want to take it, or it can be reassigned by the already assigned person or QA.

• Nobody in case the tracker issue 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.

Note

• for registration of new bugs, the 'Attach Files' field must include logs (please refer to Hints to Where to Find Log-files)

• for registration of new patches files with diffs/additions must be attached (diffs can be svn diff, either against a released version or against the newest svn).

Change Log:

Log of changes already made to the tracker issue.

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 type

• Bugs for bugs, i.e. if the issue is concerned with an error in the NetarchiveSuite package, e.g. a spelling error

• Feature Requests for feature requests, i.e. if the issue represents a suggested change in the NetarchiveSuite package, e.g. a better interface

• Patches for patches, i.e. in case it includes explicit changes and/or additions to the NetarchiveSuite package, e.g. new translation files.

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 issue 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 issue. This information must be provided as detailed as possible at the time of registering the tracker issue. 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 issue is about

• possible resolutions if known
• estimated time for fixing in case the Keywords field includes setting of the ESTIMATED keyword.

Note for registration of new Tracker Issues, the 'Detailed description' field must also include:

• Name of reporting person, in case you are not a user in the system.
• Version, in case it does not exist in the drop down list for the 'Version' field

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

If the tracker issue is a duplicate then the number of the tracker issue 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 issue.

Followup:

List of additional comments to 'Detailed description' of the tracker issue. 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 issue directed to the correct tracker issue owner.

• None
  if not set (which it must be before it is assigned to a person) (default value)

• Access
  if it concerns the Access (viewerproxy) module

• Archive
  if it concerns the Archive module

• Common
  if it concerns the Common module

• Deploy
  if it concerns the Deploy module

• Documentation
  if it concerns the documentation related to NetarchiveSuite

• Harvester
  if it concerns the Harvester module

• Monitor
  if it concerns monitoring of applications (system state)

• Test
  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 issue 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 : Must 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 issue is in the implementation process, thus it must be set during process of implementation of the tracker issue.

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

Note: External users can only see open and closed status. That means status should also be written in the 'OR Attach A Comment' field in cases where the Tracker Issue has been reported by an external user.

• New
  if new and not set (Default value)

• Need Info
  The tracker issue needs additional information before it can be evaluated. Information 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
  if the tracker issue is evaluated for when the tracker issue 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
  if the tracker issue is being implemented. That means the process of programming, documentation, unit test development and code reviews has started and no other developer should interfere without coordinating first.

• Fixed
  if the tracker issue 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
  if QA has accepted the tracker issue as fixed/implemented. Only QA must change to this status. Before a release test all tracker issues included must have this status before the release test can start.

• Fixed, Released
  if the tracker issue has been release tested and the implementation is part of a stable release.

• Duplicate
  if the tracker issue was already registered and therefore are duplicate of another tracker issue. The duplicate tracker issue number must then be noted in the 'Duplicate Of' field.

• Invalid
  if the tracker issue is not valid as a bug or feature request, e.g. if it was caused by wrong use of the system (does not make much sence for patches).

• Won’t fix
  if it is decided not to implement the tracker issue 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 issue is submitted by are automatically set.

Summary: [new, edit]

The summary consists of a short description of the tracker issue. The summary is used when an overview of tracker issue is made. This information must be provided when the tracker issue 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 issue or reproduce a bug. Version of code that the tracker issue 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.

If the version does not exist in the drop down list, please make a remark under the 'Detailed description' field or the 'OR Attach A Comment' field.

Default is None.