Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
This page describes how to submit tickets on JIRA.
Creating an Issue
- Go to the ONOS JIRA page.
- Select the Create button at the top of the page (outlined by a red box below). This will bring up the form to create an issue.
The fields of this form are:- 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 such as:
- 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
- Fill out the form and hit the create button. JIRA should generate an issue name linked to a summary of the created ticket:
If any of the fields need to be changed, the Edit button in the upper lefthand corner of the ticket will open an Edit Issue form with access to all of the fields. The issue should be visible in both the Work and Plan views of the Scrum board under Agile > ONOS Scrum Board or by searching for the ticket's name in the search bar.
Submitting a new feature proposal
In addition to following the process described above, here are the additional steps needed for submitting a new feature or project proposal.
Types of proposals:
- The proposal is related to Core ONOS modules
- The proposal is for an external module or application or product unrelated to ONOS core.
Steps
Step 1: Create a feature request in JIRA. Please select the type as "New feature".
Add "proposal" in the Labels field in JIRA:
In the Description field in JIRA (see above), add the following details:
- Problem statement
- Use case or requirements
- The problem it is trying to solve
- Other alternatives that exist and why they are not adequate
- Implementation design
- Pointers to documentation containing design and component changes
- Testing needs of the proposal
- End user impact
- API changes
- Configuration changes
- Debugging changes
- Other changes
- Work items:
- High level list of tasks along with approximate time estimates.
- Dependencies
- Assignees:
- Proposal Point of contact: Name/email
- Will this project be driven externally by a single or group of organizations? If yes, provide details.
Step 2: You can view all the submitted open feature requests and project proposals through the quick filter "New Features" at the top of the ONOS Project in JIRA.
Step 3: The ONOS releases steering team and the ONOS product owner will review the feature requests/project proposals and determine next steps. Every new feature request should be reviewed and the next steps for it should be determined in, at a maximum, 1 month from the date of submission.
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!
How do I submit a new feature request or a project proposal?
Learn more about this in the Releases section.
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.
I created an issue, but I can't find it on the Scrum board!
Make sure that the issue's Sprint field is set to the current sprint, since the swim lane (the work view) only shows those. The plan view should show all open issues, including those outside of the current sprint under the Backlogs section.
Previous : Finding, Claiming, and Working On Issues
Next : Contributing to the ONOS Codebase