Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 81 Next »

Jira

Sakai uses Atlassian's Jira software for issue management. It is used to track bug reports, suggestions for new functionality, tasked work, community contributions, etc. Outlined below are the general practices, procedures, and definitions adopted by the Sakai community for using Jira.

Definitions

Issue Type

Issue Type

Definition for Sakai

Bug

An error in design or implementation which directly impedes a user from achieving their expected result.

Task

A new capability being added to Sakai.

Feature Request

A desired capability, which may be selected for implementation in a future release of Sakai.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0903f126-e53d-4938-b4ac-fbc5fb3cebb5"><ac:plain-text-body><![CDATA[

Contributed Patch

A community-contributed patch to a particular version of sakai. The origin of such issues may lie in Bugs or Feature Requests which Sakai has not yet evaluated for implementation. Under such circumstances a linked issue is generally created by cloning the orignal issue in order to track Sakai's work on the issue. [Use at your own risk!]

]]></ac:plain-text-body></ac:structured-macro>

Status

Status

Definition for Sakai

Open

Issue is under consideration.

In Progress

Issue is actively being worked on.

Reopened

Issue was thought to be resolved, however, it did not pass QA and needs further work.

Resolved

Issue has been addressed and is ready for testing.

Closed

Work on issue is complete and has passed testing.

Resolution

Resolution

Definition for Sakai

Unresolved

Issue is under consideration and/or actively being worked on.

Fixed

Issue has been addressed through changes to the design or code. Specific details code changes can be accessed through the "Subversion Commits" tab.

Won't Fix

Issue will not be addressed because it does not match project goals. Such an issue might become a Feature Request.

Non-Issue

Issue turned out not to be a problem. Such an issue might result in a Feature Request or become an entry in the Sakaipedia if it is a common point of confusion.

Duplicate

Issue is a duplicate of a previously submitted issue. A link to the original issue is added so that progress on the issue can be easily accessed.

Incomplete

Not enough information has been provided to achieve a full understanding of the issue. An effort is made to obtain further information from the Reporter before resolving and abandoning an issue in this manner.

Cannot Reproduce

Issue cannot be reproduced. Generally these are issues solved as a by-produced of other work.

Version

Each Jira issue has an Affects Version and a Fix Version. Generally speaking Sakai uses these versions to indicate:

  • Affects Version - Version in which an issue is observed.
  • Fix Version - Version in which an issue is resolved.

Both of these versions, however, are not necessarily meaningful for all issue types. The table below summarizes how these version categories are applied in Sakai for the various issues types.

Issue Type

Affects Version

Fix Version

Bug

Version in which bug was identified.

Version in which bug is expected to be or has actually been resolved.

Task

Not required, but may provide useful context for comments on the issue.

Version in which new capabilitity is expected to appear or has appeared.

Feature Request

Not required, but may provide useful context for comments on the issue.

Not applicable. (Note that Feature Requests selected for implementation are converted to one or more Tasks for tracking the actual work.)

Contributed Patch

Version to which the patch can be applied.

Not applicable. (Note that Contributed Patches are cloned to provide a Bug or Feature Request for tracking Sakai work on the issue.)

Priority

The Priority field in Jira is used by Sakai to reflect a combination of issue characteristics, including:

  • Number of users affected
  • Resources required to resolve

In practice, the Jira Priority field is utlized by Sakai at two times: during prioritization of requirments for implementation and when making decisions on what will actually appear in a release. Initial priorities, when an issue is first reported, may be changed to reflect those needs.

As a release date approaches, prorities will also be adjusted – and lowered, if necessary – to reflect the decreasing availability of time and resources.

Priority

Definition for Sakai

Blocker

Release will not be completed until issue is resolved.

Critical

Issue will most likely be resolved for release.

Major

Issue should be resolved for release.

Minor

Issue may be resolved for release.

Trivial

Issues that might be resolved before a release.

General Workflow

What happens when an issue is created in Jira? The workflow for a given issue is dependent on what type of issue it is. The sections below describe the overall path an issue of given type will follow. Guidelines are also presented for the variours groups interactig with issues, such as Designers, Developers and QA, and discuss when and how to adjust an issue's status, resolution, versions, etc.

Genearl Workflow for Individual Issue Types

Bugs

  1. Issue is Opened.
  2. Issue is vetted for accuracy and completeness of information and linked to related issues.
  3. An initial estimate of the scope of the bug and the resources required to address it is made and an initial Priority and Fix Version are assessed.
  4. Issue is a assigned to an appropriate individual.
  5. An issue may be re-assigned to others or Watchers added to facilitate discussion of its resolution. The Priority, Fix Version, Components, etc. may also be updated as necessary.
  6. Assignee Resolves issue with relevant Resolution, when work is completed, and updates Fix Version as necessary.
  7. QA team verifies resolution of issue and Closes the issue if it is appropriately resolved, otherwise the issue is Reopened. (QA verification only occurs against releases, not against the SVN Trunk.)

Tasks

  • Issue is vetted for accuracy and completeness of information.

Feature Requests

  • Issue is vetted for accuracy and completeness of information
  • What exactly happens next to Feature Requests is being determined as part of our ongoing development of a community requirements process.

Contibuted Patches

General Workflow for Teams/Tasks

Requirements/Design

The workflow for the requirements process (post Sakai 2.1 release) is being developed in the Sakai Working Group: Requirements Process.

Developers

This workflow is aimed at those with commit privileges for Sakai.

    • When resolving an issue set Fix Version to "SVN-Trunk" in general. After Feature Freezes and during the QA cycle, if your issue is intended for the release, set the Fix Version to.
  • During QA

Quality Assurance (QA)

  • No labels