Changes between Version 17 and Version 18 of DeveloperDocumentation

Timestamp:

10/31/23 14:00:15 (6 months ago)

Author:

flichtenheld

Comment:

Add introduction to Gerrit

DeveloperDocumentation

@@ -152 +152 @@
 The way OpenVPN project handles security issues was discussed and agreed upon in the IRC meeting on [http://thread.gmane.org/gmane.network.openvpn.devel/3841 15th July 2010]. The goal is to disclose security issues in 3 weeks - or less, if a fix is ready. If a fix is not ready in 3 weeks the issue should be disclosed nevertheless and provide workarounds (if any) to users and then fix the issue a.s.a.p. Also, ''all'' security issues - whether they're theoretical or being exploited - should be fixed. Also agreed that our users should be informed about vulnerabilities in external software OpenVPN depends on (e.g. OpenSSL). This will be done after developers of the external software have already disclosed the vulnerability.
 
+= Patch submission via Gerrit =
+
+The OpenVPN project has an instance of the [https://gerrit-review.googlesource.com/ Gerrit code review tool], hosted at https://gerrit.openvpn.net/. This is intended to aid in the submission and review of bigger patches or patch series (i.e. patches that do depend on each other). Gerrit allows to
+
+* Track review comments on a patch
+* Review changes between different revisions of a patch
+* Get test builds for patches
+
+The use of Gerrit is encouraged over using [https://github.com/OpenVPN/openvpn/pulls GitHub Pull-Requests]. The main difference is that our development workflow is currently patch orientated. Even when you submit a patch series, each patch needs to stand on its own, and produce a working build. Each patch will be merged individually. Gerrit supports this model, while Pull Requests like in !GitHub or similar products are more branch-oriented.
+
+Note that we currently do directly merge the patches via the Gerrit tool. Instead they are still submitted to the mailing list for the final step of the workflow as described above. We have written a small script that facilitates sending a patch reviewed through Gerrit to the list. You can find [https://github.com/OpenVPN/openvpn/blob/master/dev-tools/gerrit-send-mail.py gerrit-send-mail.py] in the `dev-tools` directory in the Git repository. That script will take care of adding ''Acked-By'' lines automatically based on the Gerrit reviews. Anyone can submit a patch to the mailing list once it is reviewed and approved. But of course we encourage the patch author to take care of it themselves.
+
+For more information and tips about using Gerrit see GerritBestPractises.
+
 = Patch quality =