Add links to storyboard worklists to contributing.rst

These worklists exist but are not easily discoverable so
they need to be linked from somewhere. contributing.rst seemed
like the best place.

Change-Id: If74cf2f510441f500c2e13612f99631d56cf4bfe
This commit is contained in:
Chris Dent 2019-04-18 12:38:09 +01:00
parent d921ad4bc8
commit 1b5710db74
1 changed files with 39 additions and 0 deletions

View File

@ -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 <https://storyboard.openstack.org/#!/worklist/580>`_
- No tags
- New or unvisited stories which have not yet been categorized (and should
be).
* - `Bugs <https://storyboard.openstack.org/#!/worklist/574>`_
- ``bug``
- Incorrect behavior in existing code, features or documents. If the issue
is with documentation, add the tag ``docs``.
* - `Features <https://storyboard.openstack.org/#!/worklist/594>`_
- ``rfe``
- Planned or requested features or enhancements to the system.
* - `Cleanups <https://storyboard.openstack.org/#!/worklist/575>`_
- ``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
----------------------------