From 723186c5add2807fce464dc64d9ff0204cf3d3da Mon Sep 17 00:00:00 2001 From: DavHau Date: Fri, 9 Jun 2023 12:18:46 +0300 Subject: [PATCH] docs(REVIEWS.md): improve gerrit workflow explanation Change-Id: I03c156c72831931f5a1984b6ff80bdc239f75e8e Reviewed-on: https://cl.tvl.fyi/c/depot/+/8726 Tested-by: BuildkiteCI Reviewed-by: tazjin --- docs/REVIEWS.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/REVIEWS.md b/docs/REVIEWS.md index dd74e23ca..930a15c8e 100644 --- a/docs/REVIEWS.md +++ b/docs/REVIEWS.md @@ -46,8 +46,11 @@ set-url` to update the origin URL and install the hook in the same way as above. The developer workflow on Gerrit is quite different from what GitHub-users are used to. -The depot does not have branches (other than Gerrit's internal metadata refs) -and all development happens at `HEAD`. +Instead of pushing changes to remote branches, all changes have to be pushed to +`refs/for/canon`. For each commit that is pushed there, a change request is +created automatically. + +Changes should usually be based on the remote `HEAD` (the `canon` branch). Every time you create a new commit the change hook will insert a unique `Change-Id` tag into the commit message. Once you are satisfied with the state @@ -74,7 +77,7 @@ git push origin git push origin HEAD:refs/for/canon%wip ``` -TIP: Every individual commit will become a separate change. We do not merge +TIP: Every individual commit will become a separate change. We do not squash related commits, but instead submit them one by one. Be aware that if you are expecting a different behaviour and attempt something like an unsquashed subtree merge, you will produce a *lot* of CLs. This is strongly discouraged.