Browse Source

[ussuri][goal] Update contributor documentation

This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

Story: #2007236
Task: #38554

Change-Id: Ie02405c3b89b8d5f338191b7d8e58853186b4938
Ghanshyam Mann 1 year ago
4 changed files with 77 additions and 16 deletions
  1. +12
  2. +58
  3. +0
  4. +7

+ 12
- 10

@ -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:
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.
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.
Bugs should be filed on Launchpad, not GitHub:
Bugs should be filed on Launchpad:
For more specific information about contributing to this repository, see the
coverage2sql contributor guide:

+ 58
- 0
doc/source/contributor/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 <>`_ 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 coverage2sql.
* IRC channel #openstack-qa at FreeNode
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
Contacting the Core Team
Please refer the `coverage2sql Core Team
<,members>`_ contacts.
New Feature Planning
If you want to propose a new feature please read `Feature Proposal Process`_
coverage2sql features are tracked on `Launchpad BP <>`_.
Task Tracking
We track our tasks in `Launchpad <>`_.
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 <>`__.
More info about Launchpad usage can be found on `OpenStack docs page
Getting Your Patch Merged
All changes proposed to the coverage2sql requires two ``Code-Review +2`` votes from
coverage2sql 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
Release Process fir QA is documented in `QA Release Process
.. _Feature Proposal Process:

+ 0
- 4
doc/source/contributor/index.rst View File

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

+ 7
- 2
doc/source/index.rst View File

@ -15,13 +15,18 @@ if your coverage rate is down.
* Documentation:
* Source:
* Bugs:
* Contributing: If you are a new contributor to coverage2sql please refer: :doc:`contributor/contributing`
.. toctree::
:maxdepth: 2
.. toctree::
Indices and tables
@ -32,4 +37,4 @@ Indices and tables
* `OpenStack wide search <>`_: Search the wider
set of OpenStack documentation, including forums.
set of OpenStack documentation, including forums.