X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=b77f31b30654fb86bfc6939e0f15ebacbd2987be;hb=refs%2Fheads%2Fmaster;hp=dd17a205fc8b177635412c3814413625c334d10a;hpb=8f6a68ab4249b31fd1a220b5fa75b3e24e592e8a;p=lttng-ust.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd17a205..b77f31b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,9 @@ + + # LTTng-UST contributor's guide Being an open source project, the LTTng-UST project welcomes @@ -16,7 +22,7 @@ control. The upstream Git repository URL is: ## Coding standard LTTng-UST uses the -[Linux kernel coding style](http://www.kernel.org/doc/Documentation/CodingStyle). +[Linux kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html). Although the LTTng-UST code base is primarily written in C, it does contain shell, Perl, and Python code as well. There is no official coding @@ -26,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: