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: Ie02405c3b89b8d5f338191b7d8e58853186b4938
changes/19/721119/1
Ghanshyam Mann 2 years ago
parent
commit
772d75cc46
  1. 22
      CONTRIBUTING.rst
  2. 58
      doc/source/contributor/contributing.rst
  3. 4
      doc/source/contributor/index.rst
  4. 9
      doc/source/index.rst

22
CONTRIBUTING.rst

@ -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:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/coverage2sql
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.
https://docs.openstack.org/infra/manual/developers.html#development-workflow
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.
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Launchpad, not GitHub:
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/coverage2sql
For more specific information about contributing to this repository, see the
coverage2sql contributor guide:
https://docs.openstack.org/coverage2sql/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 coverage2sql.
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 the `coverage2sql Core Team
<https://review.opendev.org/#/admin/groups/1627,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 <https://blueprints.launchpad.net/coverage2sql>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/coverage2sql>`_.
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/coverage2sql/+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 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
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
Release Process fir QA is documented in `QA Release Process
<https://wiki.openstack.org/wiki/QA#Releases_Process>`_.
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions

4
doc/source/contributor/index.rst

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

9
doc/source/index.rst

@ -15,13 +15,18 @@ if your coverage rate is down.
* Documentation: https://docs.openstack.org/coverage2sql/latest/
* Source: https://opendev.org/openstack/coverage2sql
* Bugs: https://bugs.launchpad.net/coverage2sql
* Contributing: If you are a new contributor to coverage2sql please refer: :doc:`contributor/contributing`
.. toctree::
:maxdepth: 2
install/index
user/index
contributor/index
.. toctree::
:hidden:
contributor/contributing
Indices and tables
==================
@ -32,4 +37,4 @@ Indices and tables
document.
* `OpenStack wide search <https://docs.openstack.org>`_: Search the wider
set of OpenStack documentation, including forums.
set of OpenStack documentation, including forums.

Loading…
Cancel
Save