docs: Update contributing guide
authorKienan Stewart <kstewart@efficios.com>
Fri, 24 Nov 2023 14:12:37 +0000 (09:12 -0500)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Wed, 10 Jan 2024 17:08:28 +0000 (12:08 -0500)
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: I3543659b0d02ecd672f2c8a45d23975c271628f9
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
CONTRIBUTING.md
README.md

index 359a38c6cea68e44699085b2b760545a8f91fb90..b77f31b30654fb86bfc6939e0f15ebacbd2987be 100644 (file)
@@ -32,21 +32,29 @@ rest of the code written in that language is strongly encouraged.
 
 ## Creating and sending a patch
 
-LTTng-UST's development flow is primarily email-based, although we
-also accept pull requests on our
-[GitHub mirror](https://github.com/lttng/lttng-ust). If you're going
-to create GitHub pull requests, make sure you still follow the
+LTTng-UST's development flow is primarily based on
+[Gerrit Code Review](https://review.lttng.org/q/project:lttng-ust), 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-ust).
+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
+dirrectly 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:
 
index 7006cde41890158dfa08865c3e1bd3bc270ea685..f71649b4155d9f02978d3f40b12b5cf832cf9cd9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -210,6 +210,7 @@ Maintainer: [Mathieu Desnoyers](mailto:mathieu.desnoyers@efficios.com)
 
 Mailing list: [`lttng-dev@lists.lttng.org`](https://lttng.org/cgi-bin/mailman/listinfo/lttng-dev)
 
+Code review: [_lttng-ust_ project](https://review.lttng.org/q/project:lttng-ust) on LTTng Review
 
 Package contents
 ----------------
This page took 0.026207 seconds and 4 git commands to generate.