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 <tazjin@tvl.su>
This commit is contained in:
DavHau 2023-06-09 12:18:46 +03:00 committed by David Hauer
parent 9e61373096
commit 723186c5ad

View file

@ -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 The developer workflow on Gerrit is quite different from what GitHub-users are
used to. used to.
The depot does not have branches (other than Gerrit's internal metadata refs) Instead of pushing changes to remote branches, all changes have to be pushed to
and all development happens at `HEAD`. `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 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 `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 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 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 expecting a different behaviour and attempt something like an unsquashed subtree
merge, you will produce a *lot* of CLs. This is strongly discouraged. merge, you will produce a *lot* of CLs. This is strongly discouraged.