Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Anchor
Definitions
Definitions
Definitions

Anchor
Issue Type
Issue Type
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="2ca57738c7ac0065-2364e44d-467a4df7-9291be0e-001d0e7f60bf7d657f75990b"><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>

Anchor
Status
Status
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.

Anchor
Resolution
Resolution
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. When viewing an issue, the "Subversion Commits" tab provides specific details regarding code changes.

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 with Sakai. 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 identify the issue.

Cannot Reproduce

Issue cannot be reproduced. Perhaps it was a non-Sakai problem or it was resolved as a by-product of other work.

Anchor
Version
Version
Version

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

...

(star) For both Bug and Task issues the fix version is set fix version depending on whether the issues is unresolved ("expected" fix version) or resolved ("actual" fix version). For unresolved issues, which are still being worked on, the fix version is set to the "whole" release number (e.g., 2.1.0) in which the issue is expected to be resolved. For resolved issues, the fix version is initially set to the actual interim QA release number (e.g., 2.1.0.001, 2.1.0.002) in which the issue was resolved. After a release is made, the interim QA release versions are merged into a single release version number for clarity, (_i.e., 2.1.0.001, 2.1.0.002, 2.1.0.003, ... are merged into 2.1.0.)

Priority

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

...

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.

Anchor
Workflow
Workflow
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

Anchor
Bugs
Bugs
Image Modified 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.)

Anchor
Tasks
Tasks
Image Modified Tasks

  • Issue is vetted for accuracy and completeness of information.

Anchor
Feature Requests
Feature Requests
Image Modified 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.

Anchor
Contributed Patches
Contributed Patches
Image Modified 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)