4.3 KiB
Task Tracking
Note
This section assumes you have completed accounts guide.
What Task Trackers does OpenStack use?
Each project is different in the process of reporting bugs and planning new features. There are however two main tools that projects use: Launchpad and Storyboard.
Storyboard
Storyboard is kanban style task tracking system created and maintained by the community. It was designed API-first and was engineered to support the coordination of cross project work. Items tracked are stories and tasks. A story can be a bug or a new feature, while tasks are the smaller todo's required to complete the story.
For information on how to use storyboard, please go here.
Launchpad
Launchpad is the original task tracker used by OpenStack projects to organize and target work to milestones and releases. It uses UbuntuOne for authentication as it is managed by Canonical. Items tracked are either bugs or blueprints.
Blueprints
In Launchpad, a new feature is called a blueprint. To file a new blueprint, click the 'Register a blueprint' button on the right.
On the next screen you are prompted to add details including its name and title.
These are different in that the name is what is used in the generated url and the title is what displays when blueprints are listed out (name: new_ibm_driver title: New IBM ISCSI Driver). The next most important part is the summary- a description of the code change, where most of the details about the implementation is. After that, there are several optional fields you may wish to fill in- a specification url, assignee, drafter, and approver. The last two fields before registering have default values- status and propose for a sprint. For most teams, its typical to leave the default values.
It is possible to update all of this information except the name and title after the blueprint is registered. When you have finished filling out all of the information you care to include, it is good to communicate with the project team lead that you have filed a blueprint.
Bugs
Bugs are pretty self explanitory- some unexpected or unintended behavior of the software. To report a bug you have found in Launchpad, click the 'Report a bug' button from the project's overview page.
To get the details of reporting the bug you fill in the summary line and click 'next'.
Based on the summary line, Launchpad will do a quick query to see if there has been anything reported already that might be the same issue you are trying to report. It is important to look through these to avoid filing duplicate bugs and creating redundancies in the bug index. If you do not see a bug that sounds like the issue you are reporting, you can click the 'No, I need to report a new bug' button.
After clicking that button, the further information field will appear along with the 'This bug is a security vulnerability' radio box. You can edit the summary line to differentiate it from the other bugs Launchpad thought it was similar to, add details like the setup you were using, what you were doing when you hit the unexpected behavior, the error codes you encountered, etc.
If the bug is related to a security vulnerability it is important to click the box to alert the Vulnerability Management Team to the issue. When you feel you have added all of the information needed, go ahead and submit the bug report. For more information about the full process for reporting security vulnerabilties, please continue reading this page.
It is a good idea to check back on the bug routinely if you aren't actively working on solving it to make sure people haven't asked for more information about the issue. If someone has commented on the bug, try to respond with the details they need.