[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: I289f4638ade76651a0d13cc0c0786f8f5fc81bd4
This commit is contained in:
Ghanshyam Mann 2020-04-19 17:45:19 -05:00
parent be0154c17d
commit a1f024514a
3 changed files with 86 additions and 0 deletions

19
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,19 @@
The source repository for this project can be found at:
https://opendev.org/openstack/patrole
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:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Storyboard:
https://storyboard.openstack.org/#!/project/1040
For more specific information about contributing to this repository, see the
Patrole contributor guide:
https://docs.openstack.org/patrole/latest/contributor/contributing.html

View File

@ -0,0 +1,57 @@
============================
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 Tempest.
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 `Patrole Core Team
<https://review.opendev.org/#/admin/groups/1673,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read `Feature Proposal Process`_
Patrole features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/1040>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/1040>`_.
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
`StoryBoard <https://storyboard.openstack.org/#!/project/1040>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the Patrole requires one ``Code-Review +2`` votes from
Patrole core reviewers before one of the core reviewers can approve patch by
giving ``Workflow +1`` vote. More detailed guidelines for reviewers are available
at :doc:`../REVIEWING`.
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

@ -47,6 +47,16 @@ Field Guides
field_guide/index
field_guide/rbac
For Contributors
================
* If you are a new contributor to Patrole please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Developer's Guide
=================