From: Kienan Stewart <kstewart@efficios.com>
Date: Thu, 23 Nov 2023 21:34:18 +0000 (-0500)
Subject: docs: Update contributing guide
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=8d82bb77bfe9cee42f8b409c5e65f9ae4c218894;p=lttng-tools.git

docs: Update contributing guide

Indicate that Gerrit (https://review.lttng.org) is the principal place
where patches are submitted and reviewed, rather than the mailing list.

Based on feedback received on the mailing list:
https://lists.lttng.org/pipermail/lttng-dev/2023-November/030670.html

Change-Id: Icb0bc3e45bb35fa85eca272d8043e5553465f700
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0bebf12ef..696de362a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,22 +25,29 @@ rest of the code written in that language is strongly encouraged.
 
 ## Creating and sending a patch
 
-LTTng-tools's development flow is primarily email-based, although we
-also accept pull requests on our
-[GitHub mirror](https://github.com/lttng/lttng-tools) and
-[Gerrit Code Review](https://review.lttng.org). If you're going
-to create GitHub pull requests, make sure you still follow the
+LTTng-tools's development flow is primarily based on
+[Gerrit Code Review](https://review.lttng.org), although we also accept
+e-mail based patch series on the
+[`lttng-dev` mailing list](https://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev)
+and pull requests on our [GitHub mirror](https://github.com/lttng/lttng-tools).
+If you're going to create GitHub pull requests, make sure you still follow the
 guidelines below.
 
-Like a lot of open source projects, patches are submitted and reviewed
-on its development mailing list,
-[`lttng-dev`](http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev)
-(`lttng-dev@lists.lttng.org`). The mailing list is also used to share
-and comment on <abbr title="Request for Comments">RFC</abbr>s and answer
+The mailing list is also used to share and comment on
+<abbr title="Request for Comments">RFC</abbr>s and answer
 user questions.
 
-Once your changes have been committed to your local branch, you may use
-Git's [`format-patch`](https://git-scm.com/docs/git-format-patch) command
+Once your changes have been comitted to your local branch, you may use the
+[git-review](https://opendev.org/opendev/git-review) plugin to submit them
+directly to [Gerrit](https://review.lttng.org) using the following command:
+
+    git review
+
+Please note that you will need to create an account on [Gerrit](https://review.lttng.org)
+and add an SSH public key.
+
+For e-mail based patches you may use Git's
+[`format-patch`](https://git-scm.com/docs/git-format-patch) command
 to generate a patch file. The following command line generates a
 patch from the latest commit:
 
diff --git a/README.adoc b/README.adoc
index 42bdfc085..7754da0bc 100644
--- a/README.adoc
+++ b/README.adoc
@@ -245,3 +245,6 @@ Continuous integration::
 Code review::
     https://review.lttng.org/q/project:lttng-tools[_lttng{nbh}tools_ project]
     on LTTng Review
+
+Contributor's guide::
+    https://github.com/lttng/lttng-tools/blob/master/CONTRIBUTING.md
\ No newline at end of file