CONTRIBUTING.rst

   1 CONTRIBUTING TO THE OPENVPN PROJECT
   2 ===================================
   3
   4 Patches should be written against the Git "master" branch. Some patches may get
   5 backported to a release branch.
   6
   7 The preferred procedure to send patches to the "openvpn-devel" mailing list:
   8
   9 - https://lists.sourceforge.net/lists/listinfo/openvpn-devel
  10
  11 While we do not merge GitHub pull requests as-is, we do allow their use for code
  12 review purposes. After the patch has been ACKed (reviewed and accepted), it must
  13 be sent to the mailing list. This last step does not necessarily need to be done
  14 by the patch author, although that is definitely recommended.
  15
  16 When sending patches to "openvpn-devel" the subject line should be prefixed with
  17 [PATCH]. To avoid merging issues the patches should be generated with
  18 git-format-patch or sent using git-send-email. Try to split large patches into
  19 small, atomic pieces to make reviews easier.
  20
  21 Please make sure that the source code formatting follows the guidelines at
  22 https://community.openvpn.net/openvpn/wiki/CodeStyle. Automated checking can be
  23 done with uncrustify (http://uncrustify.sourceforge.net/) and the configuration
  24 file which can be found in the git repository at dev-tools/uncrustify.conf.
  25 There is also a git pre-commit hook script, which runs uncrustify automatically
  26 each time you commit and lets you format your code conveniently, if needed.
  27 To install the hook simply run: dev-tools/git-pre-commit-uncrustify.sh install
  28
  29 If you want quick feedback on a patch before sending it to openvpn-devel mailing
  30 list, you can visit the #openvpn-devel channel on irc.libera.chat. Note that
  31 you need to be logged in to Libera to join the channel:
  32
  33 - https://libera.chat/guides/registration
  34
  35 More detailed contribution instructions are available here:
  36
  37 - https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
  38
  39 Note that the process for contributing to other OpenVPN projects such as
  40 openvpn-build, openvpn-gui, tap-windows6 and easy-rsa may differ from what was
  41 described above. Please refer to the contribution instructions of each
  42 respective project.