From 3d37b344d8ffc8b586601724c10e6110a09bb0b3 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Dec 2014 08:27:13 +0100 Subject: [PATCH] Add section about cross-project dependencies As part of submitting a change, document how to handle cross-project dependencies. Change-Id: I4fc56dc8ab8ae7159fc8c6556427dbb96ff447d3 --- doc/source/developers.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/source/developers.rst b/doc/source/developers.rst index b21c542..686b987 100644 --- a/doc/source/developers.rst +++ b/doc/source/developers.rst @@ -407,6 +407,28 @@ want the rebase behavior in git review. If you would rather postpone resolving merge conflicts you can use git review ``-R`` as the last step above. +Cross-Project Dependencies +-------------------------- + +If your change has a dependency on a change outside of a project, like +a change for another project or some manual setup, here are some best +practices on marking those changes so that they merge at the right +time. + +* As a developer, mark your change with the "Work in Progress" label + until the dependencies are in. + +* Add this header line to the commit message of a change which depends + on a change in another project:: + + Depends-On: + +* Use the same topic for all changes. This allows to easily find all + changes across repositories. + +* A core reviewer might block an important change with a -2 so that it + does not get merged accidentally. + Code Review ===========