[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: #38519
Change-Id: Ia738b3f37d1b0a477838c37a91afca14108f85e3
This commit is contained in:
Ghanshyam Mann 2021-05-13 17:40:02 -05:00 committed by Ghanshyam
parent db8479f5c2
commit 72272fe978
4 changed files with 70 additions and 25 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:
http://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/python-cyborgclient
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.
http://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-cyborgclient
https://bugs.launchpad.net/openstack-cyborg
For more specific information about contributing to this repository, see the
python-cyborgclient contributor guide:
https://docs.openstack.org//python-cyborgclient/latest/contributor/contributing.html

View File

@ -1,4 +1,47 @@
============
Contributing
============
.. include:: ../../../CONTRIBUTING.rst
============================
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-cyborgclient.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-cyborg at OFTC
* Mailing list (prefix subjects with ``[cyborg]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `python-cyborgclient Core Team
<https://review.opendev.org/admin/groups/5ecdd69a9647b2854f0effd73b98580164ab7bc9>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
python-cyborgclient features are tracked on `Launchpad Bugs <https://bugs.launchpad.net/openstack-cyborg>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad Bugs <https://bugs.launchpad.net/openstack-cyborg>`_.
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 Bugs <https://bugs.launchpad.net/openstack-cyborg>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the python-cyborgclient project require one or two +2 votes
from python-cyborgclient 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
<https://docs.openstack.org/project-team-guide/ptl.html>`_.

View File

@ -1,9 +0,0 @@
===========================
Contributor Documentation
===========================
.. toctree::
:maxdepth: 2
contributing

View File

@ -15,12 +15,21 @@ Contents:
readme
install/index
library/index
contributor/index
cli/index
user/index
admin/index
reference/index
For Contributors
================
* If you are a new contributor to python-cyborgclient please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Indices and tables
==================