diff options
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..f87293c --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,34 @@ +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: + +- https://lists.sourceforge.net/lists/listinfo/openvpn-devel + +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 +git-format-patch or sent using git-send-email. Try to split large patches into +small, atomic pieces to make reviews easier. + +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.freenode.net. Note that +you need to be logged in to Freenode to join the channel: + +- http://freenode.net/faq.shtml#nicksetup + +More detailed contribution instructions are available here: + +- https://community.openvpn.net/openvpn/wiki/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 +described above. Please refer to the contribution instructions of each +respective project. |