about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorDavHau <d.hauer.it@gmail.com>2023-06-09T09·18+0300
committerDavid Hauer <d.hauer.it@gmail.com>2023-06-10T11·57+0000
commit723186c5add2807fce464dc64d9ff0204cf3d3da (patch)
tree156fd471c42a462408ba10f8189fa765a247b54b /docs
parent9e6137309621c0861d9013e8d1646f735eda6c90 (diff)
docs(REVIEWS.md): improve gerrit workflow explanation r/6260
Change-Id: I03c156c72831931f5a1984b6ff80bdc239f75e8e
Reviewed-on: https://cl.tvl.fyi/c/depot/+/8726
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
Diffstat (limited to 'docs')
-rw-r--r--docs/REVIEWS.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/REVIEWS.md b/docs/REVIEWS.md
index dd74e23caf..930a15c8e7 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.