X-Git-Url: https://git.lttng.org/?p=lttng-ust.git;a=blobdiff_plain;f=CONTRIBUTING.md;h=19f9d44dc14eb32af6c0c05c1b5ec8299bbdfd38;hp=359a38c6cea68e44699085b2b760545a8f91fb90;hb=HEAD;hpb=e03d7c66c57bf268b87296566a5160039f35ccfb 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: