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: I1b544695dc5cc1c9f2cdd5fc3f686dae94d52aaa
Ghanshyam Mann 1 year ago
3 changed files with 86 additions and 0 deletions
  1. +19
  2. +58
  3. +9

+ 19
- 0

@ -0,0 +1,19 @@
The source repository for this project can be found at:
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:
Bugs should be filed on Launchpad:
For more specific information about contributing to this repository, see the
Devstack Plugin Ceph 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 Devstack Plugin Ceph.
* IRC channel ``#openstack-qa`` at FreeNode
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
Contacting the Core Team
Please refer to the `Devstack Plugin Ceph Core Team
<,members>`_ contacts.
New Feature Planning
If you want to propose a new feature please read `Feature Proposal Process`_
Devstack 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 Devstack Plugin Ceph require two ``Code-Review +2`` votes from
core reviewers before one of the core reviewers can approve the patch by
giving ``Workflow +1`` vote.
Project Team Lead Duties
All common PTL duties are enumerated in the `PTL guide
The Release Process for QA is documented in `QA Release Process
.. _Feature Proposal Process:

+ 9
- 0
doc/source/index.rst View File

@ -7,6 +7,15 @@ Welcome to Devstack Plugin Ceph's documentation!
For Contributor
If you are a new contributor to devstack-plugin-ceph please refer: :doc:`contributor/contributing`
.. toctree::
Indices and tables