From 471ae692247cd711aab9ef7e0e26c19afe0d51e1 Mon Sep 17 00:00:00 2001 From: Zara Date: Thu, 25 Aug 2016 16:25:28 +0000 Subject: [PATCH] Document commit message syntax for StoryBoard This commit adds documentation on syntax so that people can find out how to update a StoryBoard task's status automatically when sending a patch to gerrit. Change-Id: I681a433681a525d93ef4fb4ece219c28dc3fa8da Task: 3188 --- doc/source/developers.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/doc/source/developers.rst b/doc/source/developers.rst index 411f875..d957167 100644 --- a/doc/source/developers.rst +++ b/doc/source/developers.rst @@ -217,7 +217,8 @@ Working on Bugs --------------- Bug reports for a project are generally tracked on Launchpad at -https://bugs.launchpad.net/. Contributors may review these +https://bugs.launchpad.net/, 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 `_ section of the OpenStack Git Commit Good Practices wiki page.