Browse Source

[Community goal] Update contributor documentation

As the Ussuri goal we have an OpenStack project wide contributing
documentation template [1]. pyhton-novaclient use its own bug or feature
tracking LP and core team is also not exactly same as nova  so adding
its own contributor guide with keeping common links from nova
with python-novaclient specific information.

Also the top level CONTRIBUTING.rst template has been changed in the
cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according
to the new template.

[1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst
[2] https://review.opendev.org/#/c/696001

Change-Id: Ie255a2f3e358323da1132d3c7354651ea7719ae0
Story: #2007236
Task: #38567
changes/84/724184/4
Wes Hayutin 1 year ago
parent
commit
7f1627348a
  1. 0
      doc/source/contributing_roles.rst
  2. 67
      doc/source/contributor/contributing.rst
  3. 3
      doc/source/index.rst

0
doc/source/contributing.rst → doc/source/contributing_roles.rst

67
doc/source/contributor/contributing.rst

@ -0,0 +1,67 @@
============================
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.
The information below will cover the project specific information you need to get started with TripleO.
Documentation
~~~~~~~~~~~~~
Documentation for the TripleO project can be found `here <https://docs.openstack.org/tripleo-docs/latest/index.html>`_
Communication
~~~~~~~~~~~~~
* IRC channel ``#tripleo`` at FreeNode
* Mailing list (prefix subjects with ``[tripleo]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer to the `TripleO Core Team
<https://review.opendev.org/#/admin/groups/190,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read our `Example Spec <https://opendev.org/openstack/tripleo-specs/src/branch/master/specs/template.rst>`_
Submit your feature to the `proper branch <https://opendev.org/openstack/tripleo-specs/src/branch/master/specs>`_.
TripleO features are tracked on `Launchpad BP <https://blueprints.launchpad.net/tripleo>`_.
New TripleO Policy Proposal
~~~~~~~~~~~~~~~~~~~~~~~~~~~
New policies can be proposed by submitting a policy-template
in the same way a spec file is submitted.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/tripleo>`_ and in
`StoryBoard <https://storyboard.openstack.org/#!/project_group/76>`_
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/tripleo/+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 TripleO requires two ``Code-Review +2`` votes from
TripleO 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>`_.
The Release Process for TripleO is documented in `Release Management
<https://docs.openstack.org/tripleo-docs/latest/developer/release.html>`_.
Documentation for the TripleO project can be found `here <https://docs.openstack.org/tripleo-docs/latest/index.html>`_

3
doc/source/index.rst

@ -11,8 +11,9 @@ Contents:
.. toctree::
:maxdepth: 2
contributor/contributing
installation
contributing
contributing_roles
usage
roles
modules

Loading…
Cancel
Save