diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1368e0e..57105f7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +1,25 @@ -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-brick-cinderclient-ext -If you already have a good understanding of how the system works and your -OpenStack accounts are set up, you can skip to the development workflow -section of this documentation to learn how changes to OpenStack should be -submitted for review via the Gerrit tool: +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 GitHub: +Bugs should be filed on Launchpad: - https://bugs.launchpad.net/brick-python-cinderclient-ext + https://bugs.launchpad.net/python-cinderclient + + .. note:: + When creating a bug, please tag it with 'brick-cinderclient-ext'. + To create a tag, select the 'Extra options' after filling in the + bug description and type **brick-cinderclient-ext** in the 'Tags' + text box. + +For more specific information about contributing to this repository, see the +python-brick-cinderclient-ext contributor guide: + + https://docs.openstack.org/python-brick-cinderclient-ext/latest/contributor/contributing.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..985b943 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,14 @@ +============================ +So You Want to Contribute... +============================ + +For general information on contributing to OpenStack, please check out the +`contributor guide `_ 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-brick-cinderclient-ext 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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 282f019..86b72ac 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,7 +14,7 @@ Contents: readme installation usage - contributing + contributor/contributing Indices and tables ==================