summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorGhanshyam Mann <gmann@ghanshyammann.com>2020-04-23 10:51:31 -0500
committerGhanshyam Mann <gmann@ghanshyammann.com>2020-04-23 16:56:43 +0000
commit812f10661283c092d50fbf4417901ea23a5b3f26 (patch)
treede08738b580ea51c163e8d5861f9ecec72c0db08 /CONTRIBUTING.rst
parent7d6cf15f8cad55da593a09a5aa1b5c2f25d5916e (diff)
downloadpython-novaclient-812f10661283c092d50fbf4417901ea23a5b3f26.tar.gz
[Community goal] Update contributor documentation
As the Ussuri goal we have an OpenStack project wide contributing documentation template [1]. pyhton-novaclient use its own bug or feature tracking LP and core team is also not exactly same as nova so adding its own contributor guide with keeping common links from nova with python-novaclient specific information. Also the top level CONTRIBUTING.rst template has been changed in the cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according to the new template. [1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst [2] https://review.opendev.org/#/c/696001 Change-Id: Idd35fdf54a92a4a000d0d7776884682c8722854b Story: #2007236 Task: #38541
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst21
1 files changed, 12 insertions, 9 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 20115405..d4205aed 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,16 +1,19 @@
-If you would like to contribute to the development of OpenStack,
-you must follow the steps documented at:
+The source repository for this project can be found at:
- https://docs.openstack.org/infra/manual/developers.html#development-workflow
+ https://opendev.org/openstack/python-novaclient
-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 GitHub:
+Bugs should be filed on Launchpad:
https://bugs.launchpad.net/python-novaclient
+
+For more specific information about contributing to this repository, see the
+python-novaclient contributor guide:
+
+ https://docs.openstack.org/python-novaclient/latest/contributor/contributing.html