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].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: I1b544695dc5cc1c9f2cdd5fc3f686dae94d52aaa
changes/52/721752/3
Ghanshyam Mann 2 years ago
parent
commit
6f1a6e2b9b
  1. 19
      CONTRIBUTING.rst
  2. 58
      doc/source/contributor/contributing.rst
  3. 9
      doc/source/index.rst

19
CONTRIBUTING.rst

@ -0,0 +1,19 @@
The source repository for this project can be found at:
https://opendev.org/openstack/devstack-plugin-ceph
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/devstack-plugin-ceph
For more specific information about contributing to this repository, see the
Devstack Plugin Ceph contributor guide:
https://docs.openstack.org/devstack-plugin-ceph/latest/contributor/contributing.html

58
doc/source/contributor/contributing.rst

@ -0,0 +1,58 @@
============================
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 Devstack Plugin Ceph.
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 to the `Devstack Plugin Ceph Core Team
<https://review.opendev.org/#/admin/groups/1196,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 <https://blueprints.launchpad.net/devstack-plugin-ceph>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/devstack-plugin-ceph>`_.
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/devstack-plugin-ceph/+filebug>`__.
More info about Launchpad usage can be found on `OpenStack docs page
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
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
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
The Release Process for QA is documented in `QA Release Process
<https://wiki.openstack.org/wiki/QA/releases>`_.
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions

9
doc/source/index.rst

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

Loading…
Cancel
Save