From 85f6a2b49db5544732b14ee3f0798e84329d6da1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuli=20Sepp=C3=A4nen?= Date: Thu, 19 May 2016 11:51:49 +0300 Subject: [PATCH] Update CONTRIBUTING.rst to allow GitHub PRs for code review purposes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Samuli Seppänen Acked-by: Gert Doering Message-Id: <1463647909-18383-1-git-send-email-samuli@openvpn.net> URL: http://article.gmane.org/gmane.network.openvpn.devel/11679 Signed-off-by: Gert Doering (cherry picked from commit 698f0dab76741f4ce8c1a98236786d59eca338ef) --- CONTRIBUTING.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6033097f..f87293ca 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -4,15 +4,19 @@ 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: +The preferred procedure to send patches to the "openvpn-devel" mailing list: - 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. +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