Skip to content

Commit 6e000d1

Browse files
committed
Ussuri contrib docs community goal
This patch standardizes the CONTRIBUTING.rst file and adds the required doc/source/contributor/contributing.rst The contibuting.txt points to the Swift contributor documentation. Change-Id: Ia6c105698dd0269479536645270d12a7c1061bc7
1 parent eecdcde commit 6e000d1

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

CONTRIBUTING.rst

+13-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
If you would like to contribute to the development of OpenStack, you
2-
must follow the steps in this page:
1+
The source repository for this project can be found at:
32

4-
https://docs.openstack.org/infra/manual/developers.html
3+
https://opendev.org/openstack/python-swiftclient
54

6-
Once those steps have been completed, changes to OpenStack should be
7-
submitted for review via the Gerrit tool, following the workflow
8-
documented at:
5+
Pull requests submitted through GitHub are not monitored.
96

10-
https://docs.openstack.org/infra/manual/developers.html#development-workflow
7+
To start contributing to OpenStack, follow the steps in the contribution guide
8+
to set up and use Gerrit:
119

12-
Gerrit is the review system used in the OpenStack projects. We're sorry,
13-
but we won't be able to respond to pull requests submitted through
14-
GitHub.
10+
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
1511

16-
Bugs should be filed on Launchpad, not Github:
12+
Bugs should be filed on Launchpad:
1713

18-
https://bugs.launchpad.net/python-swiftclient
14+
https://bugs.launchpad.net/python-swiftclient
15+
16+
For more specific information about contributing to this repository, see the
17+
swiftclient contributor guide:
18+
19+
https://docs.openstack.org/python-swiftclient/latest/contributor/contributing.html
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
============================
2+
So You Want to Contribute...
3+
============================
4+
5+
For general information on contributing to OpenStack, please check out the
6+
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
7+
It covers all the basics that are common to all OpenStack projects: the
8+
accounts you need, the basics of interacting with our Gerrit review system, how
9+
we communicate as a community, etc.
10+
11+
The python-swiftclient is maintained by the OpenStack Swift project.
12+
To understand our development process and how you can contribute to it, please
13+
look at the Swift project's general contributor's page:
14+
http://docs.openstack.org/swift/latest/contributor/contributing.html

doc/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Developer Documentation
1616
.. toctree::
1717
:maxdepth: 2
1818

19+
contributor/contributing
1920
cli/index
2021
service-api
2122
client-api

0 commit comments

Comments
 (0)