CONTRIBUTING: Update outdated/obsolete information

- uncrustify -> clang-format
- add Gerrit
- update Wiki links

Change-Id: I77a59b9b74a13793782fbfbff6bd2ec581f86be0
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1271
Acked-by: Arne Schwabe <arne@rfc2549.org>
Message-Id: <20251013160346.32741-1-gert@greenie.muc.de>
URL: https://sourceforge.net/p/openvpn/mailman/message/59246212/
Signed-off-by: Gert Doering <gert@greenie.muc.de>

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 67baa4ec05331f327da4495905110eb3c0987ab5..bd76f7a87b92c9ecec6c6ff21b40b7857c639df5 100644 (file)
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -4,27 +4,32 @@ CONTRIBUTING TO THE OPENVPN PROJECT
 Patches should be written against the Git "master" branch. Some patches may get
 backported to a release branch.
 
-The preferred procedure to send patches to the "openvpn-devel" mailing list:
+The preferred procedure is to send patches to the "openvpn-devel" mailing list:
 
 - https://lists.sourceforge.net/lists/listinfo/openvpn-devel
 
+Instead of directly sending patches to the list you can also create an account
+in our instance of the Gerrit review tool: https://gerrit.openvpn.net/
+See https://community.openvpn.net/Development/GerritBestPractices.
+
 While we do not merge GitHub pull requests as-is, we do allow their use for code
 review purposes. After the patch has been ACKed (reviewed and accepted), it must
 be sent to the mailing list. This last step does not necessarily need to be done
 by the patch author, although that is definitely recommended.
 
 When sending patches to "openvpn-devel" the subject line should be prefixed with
-[PATCH]. To avoid merging issues the patches should be generated with
+``[PATCH]``. To avoid merging issues the patches should be generated with
 git-format-patch or sent using git-send-email. Try to split large patches into
 small, atomic pieces to make reviews easier.
 
 Please make sure that the source code formatting follows the guidelines at
-https://community.openvpn.net/openvpn/wiki/CodeStyle. Automated checking can be
-done with uncrustify (https://uncrustify.sourceforge.net/) and the configuration
-file which can be found in the git repository at dev-tools/uncrustify.conf.
-There is also a git pre-commit hook script, which runs uncrustify automatically
+https://community.openvpn.net/Development/CodeStyle. Automated checking can be
+done with clang-format (https://community.openvpn.net/Development/CodeStyle)
+and the configuration file which can be found in the git repository at ``.clang-format``.
+
+There is also a git pre-commit hook script, which runs clang-format automatically
 each time you commit and lets you format your code conveniently, if needed.
-To install the hook simply run: dev-tools/git-pre-commit-uncrustify.sh install
+To install the hook simply run: ``dev-tools/git-pre-commit-format.sh install``
 
 If you want quick feedback on a patch before sending it to openvpn-devel mailing
 list, you can visit the #openvpn-devel channel on irc.libera.chat. Note that
@@ -34,7 +39,7 @@ you need to be logged in to Libera to join the channel:
 
 More detailed contribution instructions are available here:
 
-- https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
+- https://community.openvpn.net/Development/DeveloperDocumentation
 
 Note that the process for contributing to other OpenVPN projects such as
 openvpn-build, openvpn-gui, tap-windows6 and easy-rsa may differ from what was