Versions Compared

Key

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

...

  1. A user (anyone) Creates an Issue (please see #Create Issue Detailed Instructions first)
    • Issue is automatically assigned to a "Awaiting Review" status
  2. CLE team member Verifies the issue for accuracy (i.e. is it an actual issue) and completeness of details.
    • The team member may resolve the issue as Duplicate, Incomplete, or Cannot Reproduce if appropriate (see #Resolution).
    • The issue may be linked to other related issues.
    • The issue will be assigned to a user or group (e.g. Samigo Team or CLE Team) who can resolve it.
    • The Priority may be adjusted
    • Other attributes may be changed as needed, (Components, Affects Version, Security Level, Original Estimate, etc.)
  3. Assignee selects Start Progress and begins to work on the issue (as time and priorities allow)
    • Assignee selects Stop Progress if they are not going to work on the issue anymore for a few days and it is not resolved
  4. Assignee selects Resolve Issue with relevant #Resolution when work is completed
    • Assignee updates Fix Version to the next major release version
    • Assignee edits the issue and adds a Test Plan under "Testing"
    • Assignee edits the issue and adds relevant "Release Notes"
    • Assignee edits the issue and checks, if appropriate, Property addition/change required and/or Conversion Script Required
    • Assignee edits the issue and selects Merge for previous supported and affected releases (e.g. 2.8 Status)
    • For TasksFor tasks, if there is nothing explicit for the QA team to test, then please Close the issue is Closed.
  5. QA team verifies Validates resolution of the issue and adds a comment with details of the testing results and process.
    • If verification fails, then it is Reopened and for further work (automatically re-assigned for further work, and the Affects Version is updated to include the version tested.the user who resolved it)
    • If verification succeeds and there are no previous releases to merge to, then QA should Close the issue
    • In the process of verifying the issue, if you discover a different problem, create a new issue to capture it, rather than re-opening the current issue and re-using it; reserve re-opening only if the original problem is still present.
    • Some issues can not be easily verified and may require special testing conditions or input from developers.
    Release Manager merges the issue
    • marks the status as Validated
  6. Release Manager merges the issue (if it is a bug) to previous supported and affected releases
    • The associated version merge status is set to Resolved
    • The issue is Closed when all merges to previous releases have by the Release Manager when the last merge has been completed

Details

General Workflow

...

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, for inclusion in a future release of Sakai; ideas that come with resources interested in implementing them are more likely to be developed than those offered with the hope that someone else will step forward to do the work.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f1781b365f7763cb-0921bc8d-4cf040c4-92fca928-bfca7c85aff08fd778f645d2"><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 original issue in order to track Sakai's work on the issue. [Use at your own risk!]

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

Branch

An experimental branch of code, which may or may not be merged back into the main code after the experiment completes; identified in SVN by a branch named with the Jira Key.

...

  • (Fixed) Developers should do the following when fixing issues:
    1. All commits to subversion must include the corresponding JIRA number as the first word in the commit message. For example: svn commit -m "SAK-1234 fixed the uncaught NPE"
    2. If you are implementing a Feature Request or Contributed Patch, first use Move to covert the issue type to a Task
    3. If working in a branch, first merge your branch to trunk before resolving the issue
    4. Update Fix Version to the next major release version
    5. Add a Test Plan under "Testing"
    6. Add relevant "Release Notes"
    7. Check the boxes, if appropriate, for Property addition/change required and/or Conversion Script Required
    8. Selects Merge for previous supported and affected releases (e.g. 2.8 Status) for bugs only (features are NOT merged back)
  • (Reopened) If QA reopens an issue:
    1. QA sets the Affects Version to the version tested
    2. In the process of verifying the issue, if you discover a different problem, create a new issue to capture it, rather than re-opening the current issue and re-using it; reserve re-opening only if the original problem is still present.
    3. Some issues can not be easily verified and may require special testing conditions or input from developers.
  • (Duplicate) If it duplicates a previous issue, then the newly opened issue is:
    1. Linked to the original issue as "duplicates"
    2. Commented with a note to look at the linked-to issue to track further progress
    3. Closed with a Resolution of "Duplicate"
    4. Fix Version and should be set to "Unknown"
  • (Incorporated) If it is incorporated into a previous issue, then the newly opened issue is:
    1. Linked to the original issue as "incorporated by"
    2. Commented with a note to look at the linked-to issue to track further progress
    3. Closed with a Resolution of "Incorporated"
    4. Fix Version and should be set to "Unknown"
  • (Non-Issue) If it turns out that the issue was the result of a mis-understanding of how Sakai operates, then:
    1. An effort is made to clarify the situation.
    2. If the mis-understanding does not suggest a design flaw, then it is Closed with a Resolution of "Non-issue"; otherwise, the design flaw could be captured to Bug or Feature Request.
    3. Fix Version should be set to "Unknown"
  • (Incomplete) If insufficient information is provided to describe the issue, then:
    1. A comment is added to ask the user to include the needed information (should list the information needed)
    2. The issue is closed with a Resolution of "Incomplete"; issue can always be Reopened.
    3. Fix Version should be set to "Unknown"
  • (Cannot Reproduce) If the issue cannot be reproduced on one of the QA test servers, then:
    1. A comment is entered to indicate what was attempted to reproduce the issue (e.g. "followed steps in issue")
    2. The issue is closed with a Resolution of "Cannot Reproduce"; issue can always be Reopened.
    3. Fix Version should be set to "Unknown"

...