| 63 | | In addition |
| 64 | | |
| 65 | | * Patches should contain a 'Signed-off-by:' line at the end (git commit --signoff). |
| 66 | | * Patches must apply cleanly, without merge conflicts. Please state which code base the patch is written against. If based on the git tree, please state which branch it is to be applied to. |
| 67 | | * Everyone who has contributed to this patch should be mentioned out of courtesy and respect to all contributors and helpers on the way. If suitable valid e-mail address should be used, preferably in addition with full name. |
| 68 | | |
| 69 | | == Sending the patch == |
| 70 | | |
| 71 | | We strongly encourage using [https://git-scm.com/docs/git-send-email git send-email] for sending the patches, so that your email client does not mess up the patch. |
| 72 | | |
| 73 | | |
| 74 | | == Code contributions == |
| 75 | | |
| 76 | | All ''code patches'' need to meet certain generic quality criteria before being accepted: |
| 77 | | |
| 78 | | * All code should be useful and beneficial for several OpenVPN users. This way we avoid spoiling the code base with features which is only requested for very special conditions. |
| 79 | | * New features need to make use of #ifdef's so that they can be disabled at compile-time. This is to enable better support for embedded systems and to track which code belongs to which feature. |
| 80 | | * Patch needs to respect our [wiki:CodingConventions coding conventions] to keep the code base understandable and maintainable. |
| 81 | | |
| 82 | | Also note that the ''documentation'' (e.g. man pages) need to be updated, if |
| 83 | | |
| 84 | | * New functionality has been introduced |
| 85 | | * Old functionality has changed |
| 86 | | * Functionality has been removed |
| | 69 | In addition: |
| | 70 | |
| | 71 | * Add a 'Signed-off-by:' line at the end (git commit --signoff). |
| | 72 | * Everyone who has contributed to this patch should be mentioned out of courtesy. Use a valid e-mail address and the full name whenever possible. |
| | 73 | |
| | 74 | = Sending patches = |
| | 75 | |
| | 76 | We strongly encourage using [https://git-scm.com/docs/git-send-email git send-email] for sending the patches, so that your email client does not mess the formatting. |
