[community 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: #38536
Change-Id: Iec0f194977d124db20534f41cfef5a59698df842
Ghanshyam Mann 2021-05-14 16:33:56 -05:00 committed by Ghanshyam
parent 75a4c80f10
commit 6d9610424e
3 changed files with 68 additions and 14 deletions

View File

@ -1,17 +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:
If you already have a good understanding of how the system works and your
OpenStack accounts are set up, you can skip to the development workflow
section of this documentation to learn how changes to OpenStack should be
submitted for review via the Gerrit tool:
Pull requests submitted through GitHub are not monitored.
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.
Bugs should be filed on Launchpad, not GitHub:
Bugs should be filed on Launchpad:
For more specific information about contributing to this repository, see the
python-masakariclient contributor guide:

View File

@ -1,5 +1,47 @@
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.
Below will cover the more project specific information you need to get started
with python-masakariclient.
.. include:: ../../../CONTRIBUTING.rst
* IRC channel #openstack-masakari at OFTC
* Mailing list (prefix subjects with ``[masakari]`` for faster responses)
Contacting the Core Team
Please refer the `python-masakariclient Core Team
<https://review.opendev.org/admin/groups/23a3cb66b177425112e8d24b8f8b5a1c662cc9e5,members>`_ contacts.
New Feature Planning
python-masakariclient features are tracked on `Launchpad <https://bugs.launchpad.net/python-masakariclient>`_.
Task Tracking
We track our tasks in `Launchpad <https://bugs.launchpad.net/python-masakariclient>`_.
If you're looking for some smaller, easier work item to pick up and get started
on, search for the 'low-hanging-fruit' tag.
Reporting a Bug
You found an issue and want to make sure we are aware of it? You can do so on
`Launchpad <https://bugs.launchpad.net/python-masakariclient>`_.
Getting Your Patch Merged
All changes proposed to the python-masakariclient project require one or two +2 votes
from python-masakariclient core reviewers before one of the core reviewers can approve
patch by giving ``Workflow +1`` vote.
Project Team Lead Duties
All common PTL duties are enumerated in the `PTL guide

View File

@ -27,6 +27,16 @@ Release Notes
Release Notes <https://docs.openstack.org/releasenotes/python-masakariclient/>
For Contributors
* If you are a new contributor to Python-masakariclient please refer: :doc:`contributor/contributing`
.. toctree::
Indices and Tables