[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: #38554

Change-Id: Ie1243ddff756372aba2c2b4fdbbea63287dfa8f8
This commit is contained in:
Ghanshyam Mann 2020-04-19 17:54:44 -05:00
parent 25221afc72
commit 4467ef9bb6
4 changed files with 84 additions and 18 deletions

View File

@ -1,16 +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/openstack-health
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/openstack-health
For more specific information about contributing to this repository, see the
openstack-health contributor guide:
https://docs.openstack.org/openstack-health/latest/contributor/contributing.html

View File

@ -1,4 +0,0 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

View File

@ -0,0 +1,58 @@
============================
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 openstack-health.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-qa at FreeNode
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `openstack-health Core Team
<https://review.opendev.org/#/admin/groups/1078,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read `Feature Proposal Process`_
openstack-health features are tracked on `Launchpad BP <https://blueprints.launchpad.net/openstack-health>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/openstack-health>`_.
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/openstack-health/+filebug>`__.
More info about Launchpad usage can be found on `OpenStack docs page
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the openstack-health requires two ``Code-Review +2`` votes from
openstack-health 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>`_.
Release Process fir QA is documented in `QA Release Process
<https://wiki.openstack.org/wiki/QA#Releases_Process>`_.
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions

View File

@ -4,17 +4,26 @@
contain the root `toctree` directive.
Welcome to openstack-health's documentation!
========================================================
Contents:
============================================
Contents
--------
.. toctree::
:maxdepth: 2
readme
contributing
subunit2sql
For Contributor
---------------
If you are a new contributor to openstack-health please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Indices and tables
==================