Skip to content

Commit d12e5a8

Browse files
author
Ghanshyam Mann
committed
[ussuri][goal] Update contributor documentation
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: #38517 Change-Id: Ic973be624418d056195127bb6f621b93edc3a3ed
1 parent d2c2323 commit d12e5a8

4 files changed

Lines changed: 70 additions & 16 deletions

File tree

CONTRIBUTING.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
1-
If you would like to contribute to the development of OpenStack,
2-
you must follow the steps in this page:
1+
The source repository for this project can be found at:
2+
3+
https://opendev.org/openstack/python-cloudkittyclient
34

4-
https://docs.openstack.org/infra/manual/developers.html
5+
Pull requests submitted through GitHub are not monitored.
56

6-
Once those steps have been completed, changes to OpenStack
7-
should be submitted for review via the Gerrit tool, following
8-
the workflow documented at:
7+
To start contributing to OpenStack, follow the steps in the contribution guide
8+
to set up and use Gerrit:
99

10-
https://docs.openstack.org/infra/manual/developers.html#development-workflow
10+
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
1111

12-
Pull requests submitted through GitHub will be ignored.
12+
Bugs should be filed on Storyboard:
1313

14-
Bugs should be filed on Storyboard, not GitHub:
14+
https://storyboard.openstack.org/#!/project/895
1515

16-
https://storyboard.openstack.org/#!/project/openstack/python-cloudkittyclient
16+
For more specific information about contributing to this repository, see the
17+
python-cloudkittyclient contributor guide:
18+
19+
https://docs.openstack.org/python-cloudkittyclient/latest/contributor/contributing.html

doc/source/contributor.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
============================
2+
So You Want to Contribute...
3+
============================
4+
For general information on contributing to OpenStack, please check out the
5+
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
6+
It covers all the basics that are common to all OpenStack projects: the accounts
7+
you need, the basics of interacting with our Gerrit review system, how we
8+
communicate as a community, etc.
9+
Below will cover the more project specific information you need to get started
10+
with python-cloudkittyclient.
11+
12+
Communication
13+
~~~~~~~~~~~~~
14+
* IRC channel #cloudkitty at FreeNode
15+
* Mailing list (prefix subjects with ``[cloudkitty]`` for faster responses)
16+
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
17+
18+
Contacting the Core Team
19+
~~~~~~~~~~~~~~~~~~~~~~~~
20+
Please refer the `python-cloudkittyclient Core Team
21+
<https://review.opendev.org/admin/groups/4ac765c35f985b3ad9226da07fdcc205c1ce4fe1,members>`_ contacts.
22+
23+
New Feature Planning
24+
~~~~~~~~~~~~~~~~~~~~
25+
Cloudkitty features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/895>`_.
26+
27+
Task Tracking
28+
~~~~~~~~~~~~~
29+
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/895>`_.
30+
If you're looking for some smaller, easier work item to pick up and get started
31+
on, search for the 'low-hanging-fruit' tag.
32+
33+
Reporting a Bug
34+
~~~~~~~~~~~~~~~
35+
You found an issue and want to make sure we are aware of it? You can do so on
36+
`StoryBoard <https://storyboard.openstack.org/#!/project/895>`_.
37+
38+
Getting Your Patch Merged
39+
~~~~~~~~~~~~~~~~~~~~~~~~~
40+
All changes proposed to the python-cloudkittyclient project require one or two +2 votes
41+
from python-cloudkittyclient core reviewers before one of the core reviewers can approve
42+
patch by giving ``Workflow +1`` vote.
43+
44+
Project Team Lead Duties
45+
~~~~~~~~~~~~~~~~~~~~~~~~
46+
All common PTL duties are enumerated in the `PTL guide
47+
<https://docs.openstack.org/project-team-guide/ptl.html>`_.

doc/source/index.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,19 @@ Contents:
1212

1313
install
1414
usage
15-
contributor
1615
cli_reference
1716
api_reference/index
1817

18+
For Contributors
19+
================
20+
21+
* If you are a new contributor to python-cloudkittyclient please refer: :doc:`contributor/contributing`
22+
23+
.. toctree::
24+
:hidden:
25+
26+
contributor/contributing
27+
1928
Indices and tables
2029
==================
2130

0 commit comments

Comments
 (0)