openstack
/
placement
Code Issues Proposed changes

Merge "Fill in the bugs section of contributing.rst"

This commit is contained in:
Zuul 2019-03-28 15:59:06 +00:00 committed by Gerrit Code Review
parent debb35668e fcd99b3354
commit f678512af3
1 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/source/contributor/contributing.rst
View File

@ -30,6 +30,52 @@ visiting the ``#openstack-placement`` IRC channel on ``chat.freenode.net``.
Submitting and Managing Bugs
----------------------------
Bugs found in placement should be reported in `StoryBoard`_ by creating a new
story in the ``openstack/placement`` project.
New Bugs
~~~~~~~~
If you are submitting a new bug, explain the problem, the steps taken that led
to the bad results, and the expected results. Please also add as much of the
following information as possible:
* Relevant lines from the ``placement-api`` log.
* The OpenStack release (e.g., ``Stein``).
* The method used to install or deploy placement.
* The operating system(s) on which the placement is running.
* The version(s) of Python being used.
Tag the story with ``bug``.
Triaging Bugs
~~~~~~~~~~~~~
Triaging newly submitted bugs to confirm they really are bugs, gather missing
information, and to suggest possible solutions is one of the most important
contributions that can be made to any open source project.
If a `new bug`_ doesn't have the ``bug`` tag, add it. If it isn't a functional
problem with existing code, consider adding the ``rfe`` tag for a feature
request, or ``cleanup`` for a suggested refactoring or a reminder for future
work. An error in documentation is a ``bug``.
Leave comments on the story if you have questions or ideas. If you are
relatively certain about a solution, add the steps of that solution as tasks on
the story.
If submitting a change related to a story, the `gerrit`_ system will
automatically link to StoryBoard if you include ``Story:`` and, optionally,
``Task:`` identifiers in your commit message, like this::
Story: 2005190
Task: 29938
Using solely ``Story:`` will leave a comment referring back to the commit in
gerrit. Adding ``Task:`` will update the identified task to indicate it is in a
``Progress`` state. When the change merges, the state will be updated to
``Merged``.
Reviewing Code
--------------
@ -46,3 +92,6 @@ New Features
.. _Project Team Guide: https://docs.openstack.org/project-team-guide/
.. _Developer's Guide: https://docs.openstack.org/infra/manual/developers.html
.. _openstack-discuss: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
.. _StoryBoard: https://storyboard.openstack.org/#!/project/openstack/placement
.. _new bug: https://storyboard.openstack.org/#!/worklist/580
.. _gerrit: http://review.openstack.org/