Merge "Document commit message syntax for StoryBoard"

This commit is contained in:
Jenkins 2016-09-08 14:06:09 +00:00 committed by Gerrit Code Review
commit e8b0f71354

View File

@ -217,7 +217,8 @@ Working on Bugs
---------------
Bug reports for a project are generally tracked on Launchpad at
https://bugs.launchpad.net/<projectname>. Contributors may review these
https://bugs.launchpad.net/<projectname>, or on StoryBoard (
https://storyboard.openstack.org). Contributors may review these
reports regularly when looking for work to complete.
There are 4 key tasks with regards to bugs that anyone can do:
@ -245,12 +246,23 @@ https://wiki.openstack.org/wiki/Bugs
If you find a bug that you wish to work on, you may assign it to yourself.
When you upload a review, include the bug in the commit message for
automatic updates back to Launchpad. The following options are available::
automatic updates back to Launchpad or StoryBoard. The following options
are available for Launchpad::
Closes-Bug: #######
Partial-Bug: #######
Related-Bug: #######
and for StoryBoard::
Task: ######
Story: ######
This will change the task status in StoryBoard to 'review' while the patch
is in review, and then 'merged' once the patch is merged. When all
tasks in a story are marked 'merged', the story will automatically
change status from 'active' to 'merged'.
Also see the `Including external references
<https://wiki.openstack.org/wiki/GitCommitMessages#Including_external_references>`_
section of the OpenStack Git Commit Good Practices wiki page.