Versions Compared

Key

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

...

Issue Type

Definition for Sakai

Image Removed Image Added Bug

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

Image Removed Image Added Task

A new capability being added to Sakai.

Image Removed Image Added 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="46b5b7020cb4651f-c22245ca-48b04fc7-bec4a6a2-ec9b9082f21db40c95f196e5"><ac:plain-text-body><![CDATA[

Image Removed Image Added 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>

Image Removed Image Added 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.

  • Image Removed Image Added Bugs
    • Important to create a detailed description on how to recreate the bug
  • Image Removed Image Added Tasks
    • Tasks are used by project teams to track the addition of or changes to functionality.
    • It is not necessary to set an Affects Version for a Task.
  • Anchor
    Contributed Patches
    Contributed Patches
    Image Removed Image Added Contributed Patches
    • Issue is vetted for accuracy and completeness of information.
    • The issue is evaluated by the appropriate project team, just like a Feature Request or Branch, for inclusion in a future release of Sakai.
      • In some cases, a Contributed Patch may run counter to the Sakai design and cannot be incorporated, and maybe marked as Won't Fix and an explanation as to why provided. In this case, the contributor of the Patch may choose to continue developing the patch for future versions of Sakai.
    • Until the patch is integrated in Sakai, the community encourages the contributor to be responsive to comments and feedback provided by other users of the patch and to continue to update the patch to current versions of Sakai
  • Image Removed Image Added Feature Requests
    • Issue is vetted for accuracy, completeness of information, relevance to Sakai's overall design, etc.
      • A good Feature Request should explain clearly what a user is trying to achieve. Use cases and scenarios can be helpful in communicating that.
    • Assigned to appropriate Project Team or Working Group lead, The will evaluate and discuss such issues periodically, when the group reaches an appropriate point in the release cycle to adsorb community input.
      • If the decision is made to not address the issue, then it should be resolved as "Won't Fix" with appropriate comments.
    • When a project team is ready to address the issue, it should be Moved to a Task and an initial estimate of the Fix Version set.

...

Status

Definition for Sakai

Image Removed Image Added Open

Issue is under consideration and investigation.

Image Removed Image Added In Progress

Issue is actively being worked on.

Image Removed Image Added Reopened

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

Image Removed Image Added Resolved

Issue has been addressed and is ready for QA testing.

Image Removed Image Added Closed

Work on issue is complete and has passed testing.
NOTE: Issue may still need to be merged into related branches.

...

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.

Non-Issue

Issue turned out not to be a problem with Sakai.

Duplicate

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

Incorporated

Issue has been incorporated into another issue. A link to the other 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 and more details or steps need to be added before it can be reopened.

  • (Awaiting Review)
    1. TODO
  • (Open)
    1. TODO
  • (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"

...

Priority

Definition for Sakai

Image Removed Image Added Blocker

Release will not be completed until issue is resolved.

Image Removed Image Added Critical

Issue will most likely be resolved for release.

Image Removed Image Added Major

Issue should be resolved for release.

Image Removed Image Added Minor

Issue may be resolved for release.

Image Removed Image Added Trivial

Issues that might be resolved before a release.

...