Browse Source

[Community goal] Update contributor documentation

As the Ussuri goal we have an OpenStack project wide contributing
documentation template [1]. Nova has its own contributor documentation
so this patch adds the new contributing.rst according to the global
template and links the sections in it to the existing Nova contributor
documentation.

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: Ia12cd4acbb63f192fcaf0790b72f8e977025a9dc
Story: #2007236
Task: #38541
changes/20/712420/4
Balazs Gibizer 1 year ago
parent
commit
612c36034b
4 changed files with 85 additions and 9 deletions
  1. +12
    -9
      CONTRIBUTING.rst
  2. +62
    -0
      doc/source/contributor/contributing.rst
  3. +8
    -0
      doc/source/contributor/index.rst
  4. +3
    -0
      doc/source/index.rst

+ 12
- 9
CONTRIBUTING.rst View File

@ -1,16 +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/nova
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
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/nova
For more specific information about contributing to this repository, see the
Nova contributor guide:
https://docs.openstack.org/nova/latest/contributor/contributing.html

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

@ -0,0 +1,62 @@
============================
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 nova.
Communication
~~~~~~~~~~~~~
:doc:`how-to-get-involved`
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
The overall structure of the Nova team is documented on `the wiki
<https://wiki.openstack.org/wiki/Nova#People>`_.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read the :doc:`blueprints` page.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/nova>`__.
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/nova/+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 Nova requires two ``Code-Review +2`` votes from
Nova core reviewers before one of the core reviewers can approve patch by
giving ``Workflow +1`` vote. More detailed guidelines for reviewers of Nova
patches are available at :doc:`code-review`.
Project Team Lead Duties
~~~~~~~~~~~~~~~~~~~~~~~~
All common PTL duties are enumerated in the `PTL guide
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
For the Nova specific duties you can read the Nova PTL guide
:doc:`ptl-guide`

+ 8
- 0
doc/source/contributor/index.rst View File

@ -7,6 +7,14 @@ enhance documentation, and increase testing. Contributions of any type are
valuable, and part of what keeps the project going. Here are a list of
resources to get your started.
Basic Information
=================
.. toctree::
:maxdepth: 2
contributing
Getting Started
===============


+ 3
- 0
doc/source/index.rst View File

@ -222,6 +222,8 @@ Reference Material
For Contributors
================
* :doc:`contributor/contributing`: If you are a new contributor this should
help you to start contributing to Nova.
* :doc:`contributor/index`: If you are new to Nova, this should help you start
to understand what Nova actually does, and why.
* :doc:`reference/index`: There are also a number of technical references on
@ -234,6 +236,7 @@ For Contributors
:hidden:
contributor/index
contributor/contributing
reference/index
.. only:: html


Loading…
Cancel
Save