diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7c9b13dd..443a6a2e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,20 +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/sahara-tests -You can find more Sahara-specific info in our How To Participate guide: +Pull requests submitted through GitHub are not monitored. - https://docs.openstack.org/sahara/latest/contributor/how-to-participate.html +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html - https://docs.openstack.org/infra/manual/developers.html#development-workflow +Bugs should be filed on Storyboard: -Pull requests submitted through GitHub will be ignored. + https://storyboard.openstack.org/#!/project/openstack/sahara-tests -Bugs should be filed on Storyboard, not GitHub: +For more specific information about contributing to this repository, see the +sahara-tests contributor guide: - https://storyboard.openstack.org/#!/project/940 + https://docs.openstack.org/sahara-tests/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..413918a0 --- /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. + +sahara-tests is maintained by the OpenStack Sahara project. +To understand our development process and how you can contribute to it, please +look at the Sahara project's general contributor's page: +http://docs.openstack.org/sahara/latest/contributor/contributing.html diff --git a/doc/source/index.rst b/doc/source/index.rst index f79b5c91..627f9e35 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,6 +23,13 @@ User guide tempest-plugin +**Contributor Guide** + +.. toctree:: + :maxdepth: 1 + + contributor/contributing + Source ------ @@ -43,4 +50,3 @@ Indices and tables * :ref:`genindex` * :ref:`search` -