This section introduces how to use JIRA in order to search for, and post, bugs, feature requests, and various project tasks.
JIRA - A Quick Overview
JIRA is the issue tracking system used by the ONOS project to keep track of various tasks and works-in-progress. These topics, called issues, are categorized based on:
- Type - a general category, such as a bug, story, or new feature
- Priority - how crucial it is to address the issue
- Epics - an overarching theme, such as a specific use case, or a class of task, such as documentation or testing.
- Labels - subcategories not associated with specific Epics or Types, such as Starter tasks aimed at beginners.
- Sprint - a span of time associated with a deadline, such as a phase of the release cycle.
Essentially, each sprint is made up of a set of issues, each associated with an epic and zero or more labels. Any issues not included in a sprint are part of the backlog.
An issue itself if identified by a JIRA-generated identifier of the form ONOS-<number>. For example, the issue for creating this page in the wiki is ONOS-371, a major-priority story that is part of the Documentation epic and the current sprint.
Issue Lifecycle
Each issue is also associated with a status. The lifecycle of an issue is a series of changes to its Status field, as follows:
- Open - issue is open and may or may not be assigned
- In Progress - issue is open, is assigned to someone, and work is in progress
- Resolved - the assigned person has declared that the issue has been addressed
- Reopened - issue is not resolved and must be returned to the open status
- Closed - everyone agrees the issue has been addressed and should no longer be considered
For example, the sample workflow for a bug is:
- 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 the bug and fix
- Developer agrees it is a bug, sets the issue to 'in progress', and fixes it as they see fit
- Developer 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
Atlassian provides some great tutorials on using Jira. Unfamiliar readers should therefore visit their website. |
Remaining Sections
The first section will discuss viewing, searching for, and taking issues on the ONOS JIRA. The second section will discuss how to create issues.