Ussuri contrib docs community goal

This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst

The contibuting.txt points to the Swift contributor documentation.

Change-Id: Ia6c105698dd0269479536645270d12a7c1061bc7
This commit is contained in:
Matthew Oliver 2020-05-13 15:36:22 +10:00
parent eecdcdefbc
commit 6e000d11e4
3 changed files with 28 additions and 12 deletions

View File

@ -1,18 +1,19 @@
If you would like to contribute to the development of OpenStack, you
must follow the steps in this page:
The source repository for this project can be found at:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/python-swiftclient
Once those steps have been completed, changes to OpenStack should 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:
Gerrit is the review system used in the OpenStack projects. We're sorry,
but we won't be able to respond to pull requests submitted through
GitHub.
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Launchpad, not Github:
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/python-swiftclient
https://bugs.launchpad.net/python-swiftclient
For more specific information about contributing to this repository, see the
swiftclient contributor guide:
https://docs.openstack.org/python-swiftclient/latest/contributor/contributing.html

View File

@ -0,0 +1,14 @@
============================
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.
The python-swiftclient is maintained by the OpenStack Swift project.
To understand our development process and how you can contribute to it, please
look at the Swift project's general contributor's page:
http://docs.openstack.org/swift/latest/contributor/contributing.html

View File

@ -16,6 +16,7 @@ Developer Documentation
.. toctree::
:maxdepth: 2
contributor/contributing
cli/index
service-api
client-api