CONTRIBUTING revision 337982
1HOW TO CONTRIBUTE TO OpenSSL
2----------------------------
3
4(Please visit https://www.openssl.org/community/getting-started.html for
5other ideas about how to contribute.)
6
7Development is done on GitHub, https://github.com/openssl/openssl.
8
9To request new features or report bugs, please open an issue on GitHub
10
11To submit a patch, please open a pull request on GitHub.  If you are thinking
12of making a large contribution, open an issue for it before starting work,
13to get comments from the community.  Someone may be already working on
14the same thing or there may be reasons why that feature isn't implemented.
15
16To make it easier to review and accept your pull request, please follow these
17guidelines:
18
19    1. Anything other than a trivial contribution requires a Contributor
20    License Agreement (CLA), giving us permission to use your code. See
21    https://www.openssl.org/policies/cla.html for details.  If your
22    contribution is too small to require a CLA, put "CLA: trivial" on a
23    line by itself in your commit message body.
24
25    2.  All source files should start with the following text (with
26    appropriate comment characters at the start of each line and the
27    year(s) updated):
28
29        Copyright 20xx-20yy The OpenSSL Project Authors. All Rights Reserved.
30
31        Licensed under the OpenSSL license (the "License").  You may not use
32        this file except in compliance with the License.  You can obtain a copy
33        in the file LICENSE in the source distribution or at
34        https://www.openssl.org/source/license.html
35
36    3.  Patches should be as current as possible; expect to have to rebase
37    often. We do not accept merge commits, you will have to remove them
38    (usually by rebasing) before it will be acceptable.
39
40    4.  Patches should follow our coding style (see
41    https://www.openssl.org/policies/codingstyle.html) and compile
42    without warnings. Where gcc or clang is available you should use the
43    --strict-warnings Configure option.  OpenSSL compiles on many varied
44    platforms: try to ensure you only use portable features.  Clean builds
45    via Travis and AppVeyor are required, and they are started automatically
46    whenever a PR is created or updated.
47
48    5.  When at all possible, patches should include tests. These can
49    either be added to an existing test, or completely new.  Please see
50    test/README for information on the test framework.
51
52    6.  New features or changed functionality must include
53    documentation. Please look at the "pod" files in doc for
54    examples of our style.
55