Browse Source

[Community goal] Update contributor documentation

This patch updates the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Change-Id: Ibe1a6a3281ae7ce9fc06293f94bc1fd44a3f63be
changes/54/720654/2
Tetsuro Nakamura 2 years ago
parent
commit
ae202d2309
  1. 25
      CONTRIBUTING.rst
  2. 29
      doc/source/contributor/contributing.rst

25
CONTRIBUTING.rst

@ -1,22 +1,19 @@
If you would like to contribute to the development of the Placement service and
have never developed for an offical OpenStack project before, you must follow
the steps in this page to perform required setup:
The source repository for this project can be found at:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/placement
Once those steps have been completed, changes to OpenStack may be submitted for
review via the Gerrit tool, following the workflow documented at:
Pull requests submitted through GitHub are not monitored.
https://docs.openstack.org/infra/manual/developers.html#development-workflow
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
There is a growing suite of documentation for Placement contributors published
at:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
https://docs.openstack.org/placement/latest/contributor/index.html
Bugs should be filed on Storyboard:
Note that OpenStack does not use GitHub. Pull requests and issues submitted
there will not be seen.
https://storyboard.openstack.org/#!/project/placement
Bugs should be filed on StoryBoard:
For more specific information about contributing to this repository, see the
placement contributor guide:
https://storyboard.openstack.org/#!/project/openstack/placement
https://docs.openstack.org/placement/latest/contributor/contributing.html

29
doc/source/contributor/contributing.rst

@ -11,13 +11,25 @@
License for the specific language governing permissions and limitations
under the License.
===========================
Contributing to Placement
===========================
============================
So You Want to Contribute...
============================
For general information on contributing to OpenStack, please check out the
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
It covers all the basics that are common to all OpenStack projects: the accounts
you need, the basics of interacting with our Gerrit review system, how we
communicate as a community, etc.
Below will cover the more project specific information you need to get started
with placement.
Communication
-------------
As an official OpenStack project, Placement follows the overarching processes
outlined in the `Project Team Guide`_ and `Developer's Guide`_. Contribution is
welcomed from any interested parties and takes many different forms.
outlined in the `Project Team Guide`_. Contribution is welcomed from any
interested parties and takes many different forms.
To make sure everything gets the attention it deserves and work is not
duplicated there are some guidelines, stated here.
@ -310,8 +322,12 @@ should be re-proposed (via gerrit) to the current cycle. Include
If there have been no changes, core reviewers should feel free to fast-approve
(only one ``+2`` required) the change.
Project Team Lead Duties
------------------------
PTL duties are enumerated in the `PTL guide`_.
.. _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
.. _list archive: http://lists.openstack.org/pipermail/openstack-discuss/
.. _StoryBoard: https://storyboard.openstack.org/#!/project/openstack/placement
@ -325,3 +341,4 @@ If there have been no changes, core reviewers should feel free to fast-approve
.. _stein schedule: https://releases.openstack.org/stein/schedule.html
.. _release note: https://docs.openstack.org/reno/latest/
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _PTL guide: https://docs.openstack.org/project-team-guide/ptl.html

Loading…
Cancel
Save