Merge "[community goal] Update contributor documentation"

This commit is contained in:
Zuul 2021-06-15 13:05:47 +00:00 committed by Gerrit Code Review
commit 5c6cd7624a
3 changed files with 83 additions and 2 deletions

View File

@ -1 +0,0 @@
doc/source/contribute.rst

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/rally
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 Launchpad:
https://bugs.launchpad.net/rally
For more specific information about contributing to this repository, see the
rally contributor guide:
https://docs.openstack.org/rally/latest/contributor/contributing.html

View File

@ -0,0 +1,48 @@
============================
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 Rally.
Communication
~~~~~~~~~~~~~
* Gitter channel https://gitter.im/xRally/Lobby
* IRC channel #openstack-rally at OFTC
* Mailing list (prefix subjects with ``[rally]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `rally Core Team
<https://review.opendev.org/admin/groups/b809b67b705ecb181cef2e1e68e06cac5c61882b>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
rally features are tracked on `Launchpad <https://bugs.launchpad.net/rally>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/rally>`_.
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/rally>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the rally project require one or two +2 votes
from rally 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

@ -43,6 +43,21 @@ Contents
task/index
verification/index
plugins/index
contribute
feature_requests
project_info/index
For Contributors
================
* If you are a new contributor to Rally please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
.. toctree::
:maxdepth: 2
contribute