1291709SjkimHOW TO CONTRIBUTE TO OpenSSL
2291709Sjkim----------------------------
3291709Sjkim
4291709SjkimDevelopment is coordinated on the openssl-dev mailing list (see
5291709Sjkimhttp://www.openssl.org for information on subscribing). If you
6291709Sjkimwould like to submit a patch, send it to rt@openssl.org with
7291709Sjkimthe string "[PATCH]" in the subject. Please be sure to include a
8291709Sjkimtextual explanation of what your patch does.
9291709Sjkim
10291709SjkimYou can also make GitHub pull requests. If you do this, please also send
11291709Sjkimmail to rt@openssl.org with a brief description and a link to the PR so
12291709Sjkimthat we can more easily keep track of it.
13291709Sjkim
14291709SjkimIf you are unsure as to whether a feature will be useful for the general
15291709SjkimOpenSSL community please discuss it on the openssl-dev mailing list first.
16291709SjkimSomeone may be already working on the same thing or there may be a good
17291709Sjkimreason as to why that feature isn't implemented.
18291709Sjkim
19291709SjkimPatches should be as up to date as possible, preferably relative to the
20291709Sjkimcurrent Git or the last snapshot. They should follow our coding style
21291709Sjkim(see https://www.openssl.org/policies/codingstyle.html) and compile without
22291709Sjkimwarnings using the --strict-warnings flag.  OpenSSL compiles on many varied
23291709Sjkimplatforms: try to ensure you only use portable features.
24291709Sjkim
25291709SjkimOur preferred format for patch files is "git format-patch" output. For example
26291709Sjkimto provide a patch file containing the last commit in your local git repository
27291709Sjkimuse the following command:
28291709Sjkim
29291709Sjkim# git format-patch --stdout HEAD^ >mydiffs.patch
30291709Sjkim
31291709SjkimAnother method of creating an acceptable patch file without using git is as
32291709Sjkimfollows:
33291709Sjkim
34291709Sjkim# cd openssl-work
35291709Sjkim# [your changes]
36291709Sjkim# ./Configure dist; make clean
37291709Sjkim# cd ..
38291709Sjkim# diff -ur openssl-orig openssl-work > mydiffs.patch
39