612c36034b
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
63 lines
1.9 KiB
ReStructuredText
63 lines
1.9 KiB
ReStructuredText
============================
|
|
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`
|