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: I07a94bbafe04e52f8594740dd5fbfe836ed54506
changes/20/721120/4
Ghanshyam Mann 1 year ago
parent
commit
b22533e6a0
4 changed files with 69 additions and 16 deletions
  1. +13
    -11
      CONTRIBUTING.rst
  2. +0
    -4
      doc/source/contributing.rst
  3. +55
    -0
      doc/source/contributor/contributing.rst
  4. +1
    -1
      doc/source/index.rst

+ 13
- 11
CONTRIBUTING.rst View File

@ -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:
http://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/tempest-stress
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.
http://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/tempest
https://bugs.launchpad.net/tempest (We use Tempest Launchpad for tempest-stress bugs tracking.)
For more specific information about contributing to this repository, see the
tempest-stress contributor guide:
https://docs.openstack.org/tempest-stress/latest/contributor/contributing.html

+ 0
- 4
doc/source/contributing.rst View File

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

+ 55
- 0
doc/source/contributor/contributing.rst View File

@ -0,0 +1,55 @@
============================
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 tempest-stress.
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 `tempest-stress Core Team
<https://review.opendev.org/#/admin/groups/1860,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read `Feature Proposal Process`_
Task Tracking
~~~~~~~~~~~~~
There is no separate task tracking tool for tempest-stress, we track our
tasks in `Launchpad <https://bugs.launchpad.net/tempest>`__.
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/tempest/+filebug>`__. There is no separate
Launchpad for tempest-stress.
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 tempest-stress requires single ``Code-Review +2`` votes as minimum from
tempest-stress core reviewers who 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>`_.
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

+ 1
- 1
doc/source/index.rst View File

@ -14,7 +14,7 @@ Contents:
readme
installation
usage
contributing
contributor/contributing
Indices and tables
==================


Loading…
Cancel
Save