From 612c36034b8f389fc3ddf18689e8e72d5b897ae8 Mon Sep 17 00:00:00 2001 From: Balazs Gibizer Date: Wed, 11 Mar 2020 10:38:56 +0100 Subject: [PATCH] [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 --- CONTRIBUTING.rst | 21 +++++---- doc/source/contributor/contributing.rst | 62 +++++++++++++++++++++++++ doc/source/contributor/index.rst | 8 ++++ doc/source/index.rst | 3 ++ 4 files changed, 85 insertions(+), 9 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 535791a45123..f3f8b3ae208a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000000..132ad285c475 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,62 @@ +============================ +So You Want to Contribute... +============================ + +For general information on contributing to OpenStack, please check out the +`contributor guide `_ 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 +`_. + +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 `__. + +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 `__. +More info about Launchpad usage can be found on `OpenStack docs page +`_. + +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 +`_. + +For the Nova specific duties you can read the Nova PTL guide +:doc:`ptl-guide` diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 662373aceebe..2889199147e6 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -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 =============== diff --git a/doc/source/index.rst b/doc/source/index.rst index 8dd745533c62..042884fc08c6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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