From d6c337411ff702e11d466118853788b0425ca60c Mon Sep 17 00:00:00 2001 From: Kienan Stewart Date: Fri, 24 Nov 2023 09:12:37 -0500 Subject: [PATCH] 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: I3543659b0d02ecd672f2c8a45d23975c271628f9 Signed-off-by: Kienan Stewart Signed-off-by: Mathieu Desnoyers --- CONTRIBUTING.md | 30 +++++++++++++++++++----------- README.md | 1 + 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 359a38c6..b77f31b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 RFCs and answer +The mailing list is also used to share and comment on +RFCs 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: diff --git a/README.md b/README.md index 7006cde4..f71649b4 100644 --- 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 ---------------- -- 2.34.1