From c5557f03dab24c2525451fa4bc2f94b0cb244576 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 1 Nov 2019 11:34:13 -0400 Subject: [PATCH] doc: link to nova code review guide from dev policies The development policies section on code review was linking to the generic openstack review guidelines but we have nova-specific guidelines as well so this changes the policies page to link to the nova code review guidelines, links the general guidelines into the nova page, and also fixes a formatting issue in the nova code review guidelines page. Change-Id: I725570d0d737f18fe8b105dc8382c4abcfdef295 --- doc/source/contributor/code-review.rst | 7 +++++-- doc/source/contributor/policies.rst | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/source/contributor/code-review.rst b/doc/source/contributor/code-review.rst index 3d42f65017..8d309ca997 100644 --- a/doc/source/contributor/code-review.rst +++ b/doc/source/contributor/code-review.rst @@ -4,7 +4,10 @@ Code Review Guide for Nova ========================== -This is a very terse set of points for reviewers to consider when +OpenStack has a general set of code review guidelines: +https://docs.openstack.org/infra/manual/developers.html#peer-review + +What follows is a very terse set of points for reviewers to consider when looking at nova code. These are things that are important for the continued smooth operation of Nova, but that tend to be carried as "tribal knowledge" instead of being written down. It is an attempt to @@ -22,7 +25,7 @@ RPC API Versions * The manager-side (example: compute/manager) needs a version bump * The manager-side method needs to tolerate older calls as well as - newer calls + newer calls * Arguments can be added as long as they are optional. Arguments cannot be removed or changed in an incompatible way. * The RPC client code (example: compute/rpcapi.py) needs to be able diff --git a/doc/source/contributor/policies.rst b/doc/source/contributor/policies.rst index 5f3133695f..e2b101e56b 100644 --- a/doc/source/contributor/policies.rst +++ b/doc/source/contributor/policies.rst @@ -59,7 +59,7 @@ As a patch author, you should try to offset the reviewer resources spent on your patch by reviewing other patches. If no one does this, the review team (cores and otherwise) become spread too thin. -For review guidelines see: https://docs.openstack.org/infra/manual/developers.html#peer-review +For review guidelines see: :doc:`code-review` Reverts for Retrospective Vetos ===============================