summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGhanshyam Mann <gmann@ghanshyammann.com>2021-08-30 12:06:10 -0500
committerGhanshyam <gmann@ghanshyammann.com>2021-08-30 17:13:12 +0000
commit6ce7da8aeb7e5d1347940433e087036e8e43eaa6 (patch)
tree52865ed8425ffc9f7158bb536274b081dade54af
parentd9c556e69a8b05cacbbcea612833e654de7b2b85 (diff)
downloadpython-openstackclient-6ce7da8aeb7e5d1347940433e087036e8e43eaa6.tar.gz
[community goal] Update contributor documentation5.6.0
This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38547 Change-Id: I0afa1796d488a96160f4a7fd615920d05fe1771c
-rw-r--r--CONTRIBUTING.rst29
1 files changed, 20 insertions, 9 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 69ecd79c..f8732b72 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,16 +1,27 @@
-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
+ https://opendev.org/openstack/python-openstackclient
-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 Storyboard, not GitHub or Launchpad:
+Bugs should be filed on StoryBoard:
https://storyboard.openstack.org/#!/project/openstack/python-openstackclient
+
+Developers should also join the discussion on the mailing list, at:
+
+ http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
+
+or join the IRC channel on
+
+ #openstack-sdks on OFTC (irc.oftc.net)
+
+For more specific information about contributing to this repository, see the
+openstacksdk contributor guide:
+
+ https://docs.openstack.org/openstacksdk/latest/contributor/index.html