CONTRIBUTING revision 306195 
1HOW TO CONTRIBUTE TO PATCHES OpenSSL
2------------------------------------
3
4(Please visit https://www.openssl.org/community/getting-started.html for
5other ideas about how to contribute.)
6
7Development is coordinated on the openssl-dev mailing list (see the
8above link or https://mta.openssl.org for information on subscribing).
9If you are unsure as to whether a feature will be useful for the general
10OpenSSL community you might want to discuss it on the openssl-dev mailing
11list first.  Someone may be already working on the same thing or there
12may be a good reason as to why that feature isn't implemented.
13
14The best way to submit a patch is to make a pull request on GitHub.
15(It is not necessary to send mail to rt@openssl.org to open a ticket!)
16If you think the patch could use feedback from the community, please
17start a thread on openssl-dev.
18
19You can also submit patches by sending it as mail to rt@openssl.org.
20Please include the word "PATCH" and an explanation of what the patch
21does in the subject line.  If you do this, our preferred format is "git
22format-patch" output. For example to provide a patch file containing the
23last commit in your local git repository use the following command:
24
25    % git format-patch --stdout HEAD^ >mydiffs.patch
26
27Another method of creating an acceptable patch file without using git is as
28follows:
29
30    % cd openssl-work
31    ...make your changes...
32    % ./Configure dist; make clean
33    % cd ..
34    % diff -ur openssl-orig openssl-work >mydiffs.patch
35
36Note that pull requests are generally easier for the team, and community, to
37work with.  Pull requests benefit from all of the standard GitHub features,
38including code review tools, simpler integration, and CI build support.
39
40No matter how a patch is submitted, the following items will help make
41the acceptance and review process faster:
42
43    1. Anything other than trivial contributions will require a contributor
44    licensing agreement, giving us permission to use your code. See
45    https://www.openssl.org/policies/cla.html for details.
46
47    2.  All source files should start with the following text (with
48    appropriate comment characters at the start of each line and the
49    year(s) updated):
50
51        Copyright 20xx-20yy The OpenSSL Project Authors. All Rights Reserved.
52
53        Licensed under the OpenSSL license (the "License").  You may not use
54        this file except in compliance with the License.  You can obtain a copy
55        in the file LICENSE in the source distribution or at
56        https://www.openssl.org/source/license.html
57
58    3.  Patches should be as current as possible.  When using GitHub, please
59    expect to have to rebase and update often. Note that we do not accept merge
60    commits. You will be asked to remove them before a patch is considered
61    acceptable.
62
63    4.  Patches should follow our coding style (see
64    https://www.openssl.org/policies/codingstyle.html) and compile without
65    warnings. Where gcc or clang is availble you should use the
66    --strict-warnings Configure option.  OpenSSL compiles on many varied
67    platforms: try to ensure you only use portable features.
68
69    5.  When at all possible, patches should include tests. These can either be
70    added to an existing test, or completely new.  Please see test/README
71    for information on the test framework.
72
73    6.  New features or changed functionality must include documentation. Please
74    look at the "pod" files in doc/apps, doc/crypto and doc/ssl for examples of
75    our style.
76