diff options
| author | Zuul <zuul@review.opendev.org> | 2020-06-01 23:33:33 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-06-01 23:33:33 +0000 |
| commit | d1e69b195b2c40f3ecc30563722858d4af24dad7 (patch) | |
| tree | 7029785667921ddac5ae62764a3a090dabb7dfaf | |
| parent | 9b6d1c7e88df409fdf272dd0a97e5f65c5fadd50 (diff) | |
| parent | 6e000d11e45e6c6c4d7c236d3c42338d685b95ae (diff) | |
| download | python-swiftclient-d1e69b195b2c40f3ecc30563722858d4af24dad7.tar.gz | |
Merge "Ussuri contrib docs community goal"
| -rw-r--r-- | CONTRIBUTING.rst | 25 | ||||
| -rw-r--r-- | doc/source/contributor/contributing.rst | 14 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 |
3 files changed, 28 insertions, 12 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0bde968..493a6c5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..b9f1e91 --- /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 <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
\ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index ab05c6b..ae30972 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,6 +16,7 @@ Developer Documentation .. toctree:: :maxdepth: 2 + contributor/contributing cli/index service-api client-api |