[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: #38556
Change-Id: I0b404a71955222427bc1b4bd2e6e93c6ad0ea89a
This commit is contained in:
Ghanshyam Mann 2021-05-17 19:25:00 -05:00 committed by Ghanshyam
parent 4a3bc3d8f5
commit 3bf875febf
4 changed files with 68 additions and 17 deletions

View File

@ -1,14 +1,19 @@
If you would like to contribute to the development of OpenStack, start by
following the steps in this page:
https://docs.openstack.org/infra/manual/developers.html
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:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
https://opendev.org/openstack/reno
Pull requests submitted through GitHub will be ignored.
Pull requests submitted through GitHub are not monitored.
Bugs should be filed on Storyboard, not GitHub:
https://storyboard.openstack.org/#!/project/933
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/933
For more specific information about contributing to this repository, see the
reno contributor guide:
https://docs.openstack.org/reno/latest/contributor/contributing.html

View File

@ -0,0 +1,42 @@
============================
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 Reno.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-release at FreeNode
* Mailing list (prefix subjects with ``[release]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `reno Core Team
<https://review.opendev.org/admin/groups/82d77855547a7c8c68f67a527d94bcf276effa65,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
reno features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/933>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/933>`_.
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/933>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the reno project require one or two +2 votes
from reno core reviewers before one of the core reviewers can approve
patch by giving ``Workflow +1`` vote.

View File

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

View File

@ -18,5 +18,14 @@ Contents
user/index
install/index
contributor/index
releasenotes/index
For Contributors
================
* If you are a new contributor to Reno please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing