summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamuli Seppänen <samuli@openvpn.net>2015-10-10 16:41:14 +0300
committerGert Doering <gert@greenie.muc.de>2015-10-10 15:48:55 +0200
commit0c1d92291e4c1829bf503067e1f9d39328d01ee9 (patch)
tree2f29033a1c50ffa315b5dd7490d6576baf984b73
parentb51a024a7b26e691e6459964d4d29f15b70089bd (diff)
downloadopenvpn-0c1d92291e4c1829bf503067e1f9d39328d01ee9.zip
openvpn-0c1d92291e4c1829bf503067e1f9d39328d01ee9.tar.gz
openvpn-0c1d92291e4c1829bf503067e1f9d39328d01ee9.tar.xz
Add CONTRIBUTING.rst
Signed-off-by: Samuli Seppänen <samuli@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <1444484474-6471-1-git-send-email-samuli@openvpn.net> Signed-off-by: Gert Doering <gert@greenie.muc.de>
-rw-r--r--CONTRIBUTING.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..6033097
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,30 @@
+CONTRIBUTING TO THE OPENVPN PROJECT
+===================================
+
+Patches should be written against the Git "master" branch. Some patches may get
+backported to a release branch.
+
+We do not currently accept GitHub pull requests for the core OpenVPN project.
+Instead, all patches must be sent to "openvpn-devel" mailing list for review:
+
+- https://lists.sourceforge.net/lists/listinfo/openvpn-devel
+
+The subject line should preferably 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.