From 58cafde03d81dc9b571948a12bc21a6c851f36ee Mon Sep 17 00:00:00 2001 From: sterni Date: Tue, 21 Jan 2025 15:21:00 +0100 Subject: [PATCH] docs(REVIEWS): link additional related documentation Unfortunately, the git book doesn't link the man pages of the involved tools, but I assume users will figure out to read them on their own. I've not linked https://git-send-email.io due to the slight reservation that it's not an official resource (and is an advertisment), but I don't feel strongly on that. The linked chapter of the Git Book links it in a footnote anyways. Change-Id: I70e3c75396006256c775f84bc7aeb5a4bde081a1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/13032 Tested-by: BuildkiteCI Reviewed-by: tazjin Autosubmit: sterni --- docs/REVIEWS.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/REVIEWS.md b/docs/REVIEWS.md index a48833471..dc6d15163 100644 --- a/docs/REVIEWS.md +++ b/docs/REVIEWS.md @@ -103,7 +103,9 @@ git push origin HEAD:refs/for/canon%wip 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. +merge, you will produce a *lot* of CLs (read +[how to import another project properly][importing-projects]). +This is strongly discouraged. During your review, the reviewer(s) might ask you to make changes. You can simply amend your commit(s) and push to the same ref. Gerrit will automatically @@ -159,6 +161,8 @@ Create an appropriate commit locally and send it us using either of these option * `git send-email`: If configured on your system, this will take care of the whole emailing process for you. +For more details, refer to the [official git documentation][git-contributing-email]. + The email address is a [public inbox][]. ## Gerrit for GitHub Users @@ -204,3 +208,5 @@ read. [github-diff]: https://gerrit.wikimedia.org/r/Documentation/intro-gerrit-walkthrough-github.html [attention sets]: https://gerrit-review.googlesource.com/Documentation/user-attention-set.html [attention-set-rules]: https://gerrit-review.googlesource.com/Documentation/user-attention-set.html#_rules +[git-contributing-email]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_project_over_email +[importing-projects]: ./importing-projects.md