We use JIRA to manage all issues in ONOS. Atlassian provides some great tutorials on using Jira, visit their website.

Creating an Issue

Go to the ONOS JIRA page

Select the create button at the top of the page. This will bring up the form to create an issue.

• Project - select project, usually ONOS
• Issue type - choose an issue type using these guidelines:
  • bug - the issue is reporting a defect
  • new feature - the issue is requesting a new user visible feature be added - used for small requests - for larger requests, use story
  • task - the issue is being used to track some task that is to be performed - often stories are composed of multiple tasks
  • improvement - the issue requests an improvement - clarify documentation for example - it is not a defect, but it could be better
  • epic - this will be used by the product owner to create new epics - please do not create issues of this type
  • story - the issue is a user story - typically for some larger change or improvement to ONOS
• Summary - enter a summary of the issue that is meaningful to someone reading only summaries in a list
• Priority - choose a priority for the issue based on the viewpoint of the person requesting work to be done
  • Blocker - Highest priority, it is stopping people from doing work
  • Critical - Needs to be addressed right away
  • Minor - Can wait until blocker and critical issues are addressed
  • Trivial - very simple issue, address when possible
• Due date - enter due date if applicable - do not rely on this field to drive work to complete by this date
• Component - select the component if known, otherwise leave blank
• Affects Version(s) - select versions affected if it is a bug, otherwise leave blank
• Fix Version(s) - do not change, will be used by release management
• Assignee - enter person assigned to the issue if known, else choose Automatic
• Environment - enter information to help the person assigned understand the context of the issue - if it is a bug enter all of the relevant information about the environment in which the bug was found
• Description - enter a description of the issue so that it is clear what is being addressed or requested
• Original Estimate - leave blank unless you are using it for planning
• Remaining Estimate - leave blank unless you are using it for tracking
• Attachment - attach any relevant documents for this issue (log files for a bug, for example)
• Labels - add a label to help find related issues - ONOS defines some standard labels
  • Test - for issues that are related to testing
  • Starter - easier issues good for beginners
• Epic Link - select the epic to which the issue belongs, if there is one - ONOS will have well defined epics during each release cycle for the larger themes being worked on
• Sprint - if using agile, enter the sprint in this field

Issue Lifecycle

The lifecycle of an issue is a series of changes to its Status field.

• Open - issue is open and may or may not be assigned
• In Progress - issue is open, is assigned, and in progress
• Resolved - the assigned person has declared that the issue has been addressed
• Reopened - issue is not resolved and must be reopened
• Closed - everyone agrees the issue has been addressed and should no longer be considered

Sample workflow for a bug: 

• Tester finds a bug, opens an issue - it is now in open status
• Component owner or manager assigns the issue to a developer to re-create and fix
• Developer agrees it is a bug and fixes it - moves the issue status to resolved and assignee to the tester who will validate the fix
  • Tester agrees it is resolved and moves issue to closed --or--
  • Tester disagrees it is resolved and moves issue to reopened, assigns it back to developer

JIRA Issues FAQ

How do I find an issue to work on?

If you are new to ONOS and want to ease into it, search for an issue that has the label "Starter" and which is not assigned. Then, assign yourself!

Documentation vs Software - What is the difference?

The way that a documentation issue is different from a software issue is the epic. A documentation issue will have a documentation epic link.