openstack
/
python-cinderclient
Code Issues Proposed changes

Ussuri contrib docs community goal 

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

Change-Id: I892e49f96573b77b46bd8847a5d2ac8254e8e5e1
This commit is contained in:
Brian Rosmaita 2020-03-03 08:42:23 -05:00
parent 8d0d0521c6
commit 9191d76450
3 changed files with 28 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.rst
View File

@ -1,16 +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-cinderclient
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:
Pull requests submitted through GitHub will be ignored.
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Launchpad, not in GitHub's issue tracker:
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/python-cinderclient
https://bugs.launchpad.net/python-cinderclient
For more specific information about contributing to this repository, see the
cinderclient contributor guide:
https://docs.openstack.org/python-cinderclient/latest/contributor/contributing.html

14
doc/source/contributor/contributing.rst Normal file
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-cinderclient is maintained by the OpenStack Cinder project.
To understand our development process and how you can contribute to it, please
look at the Cinder project's general contributor's page:
http://docs.openstack.org/cinder/latest/contributor/contributing.html

1
doc/source/index.rst
View File

@ -57,6 +57,7 @@ Developer Guides
.. toctree::
:maxdepth: 2
contributor/contributing
contributor/functional_tests
contributor/unit_tests