diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 1427eb716..f350538ff 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -26,6 +26,45 @@ If in doubt, ask someone, either by sending a message to the `openstack-discuss`_ mailing list with a ``[placement]`` subject tag, or by visiting the ``#openstack-placement`` IRC channel on ``chat.freenode.net``. +StoryBoard +---------- + +Placement uses `StoryBoard`_ for tracking bugs, features, and "cleanups" +(described below). Different types of stories are distinguished by tags which +are applied manually by people creating or reviewing the stories. These tags +are used to create work lists. + +.. list-table:: Worklists + :header-rows: 1 + + * - List + - Main Tag + - Description + * - `Untriaged Stories `_ + - No tags + - New or unvisited stories which have not yet been categorized (and should + be). + * - `Bugs `_ + - ``bug`` + - Incorrect behavior in existing code, features or documents. If the issue + is with documentation, add the tag ``docs``. + * - `Features `_ + - ``rfe`` + - Planned or requested features or enhancements to the system. + * - `Cleanups `_ + - ``cleanup`` + - Improvements to the code or surrounding repository to help with + maintenance or other development lifecycle issues that are not otherwise + a bug or feature. + +When a story has been completed it can be removed from the list by being tagged +with ``fixed``. + +.. note:: + + These worklists and their chosen tags are subject to change as the project + gains more experience with StoryBoard. The tags chosen thus far are, in + part, the result of them already existing elsewhere in the system. Submitting and Managing Bugs ----------------------------