[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: Iaec58e0b4d4356144efd626a55c2cb7913e08f3a
This commit is contained in:
Ghanshyam Mann 2020-04-19 17:52:13 -05:00
parent d5c66507d3
commit ce1af65b21
4 changed files with 77 additions and 15 deletions

View File

@ -1,16 +1,19 @@
If you would like to contribute to the development of OpenStack, The source repository for this project can be found at:
you must follow the steps in this page:
- https://docs.openstack.org/infra/manual/developers.html https://opendev.org/openstack/os-testr
Once those steps have been completed, changes to OpenStack Pull requests submitted through GitHub are not monitored.
should be submitted for review via the Gerrit tool, following
the workflow documented at:
- 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/os-testr https://bugs.launchpad.net/os-testr
For more specific information about contributing to this repository, see the
os-testr contributor guide:
https://docs.openstack.org/os-testr/latest/contributor/contributing.html

View File

@ -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 os-testr.
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 `os-testr Core Team
<https://review.opendev.org/#/admin/groups/667,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read `Feature Proposal Process`_
os-testr features are tracked on `Launchpad BP <https://blueprints.launchpad.net/os-testr>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/os-testr>`_.
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/os-testr/+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 os-testr require two ``Code-Review +2`` votes from
os-testr 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

View File

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

View File

@ -15,6 +15,7 @@ A testr wrapper to provide functionality for OpenStack projects.
* Documentation: https://docs.openstack.org/os-testr/ * Documentation: https://docs.openstack.org/os-testr/
* Source: https://opendev.org/openstack/os-testr * Source: https://opendev.org/openstack/os-testr
* Bugs: https://bugs.launchpad.net/os-testr * Bugs: https://bugs.launchpad.net/os-testr
* Contributing: If you are a new contributor to os-testr please refer: :doc:`contributor/contributing`
Contents Contents
======== ========
@ -23,9 +24,13 @@ Contents
:maxdepth: 2 :maxdepth: 2
install/index install/index
contributor/index
user/index user/index
.. toctree::
:hidden:
contributor/contributing
Indices and tables Indices and tables
================== ==================