CONTRIBUTING 2.6 KB
Newer Older
1 2
HOW TO CONTRIBUTE TO OpenSSL
----------------------------
3

M
Matt Caswell 已提交
4
(Please visit https://www.openssl.org/community/getting-started.html for
R
Rich Salz 已提交
5
other ideas about how to contribute.)
6

7
Development is done on GitHub, https://github.com/openssl/openssl.
8

9
To request new features or report bugs, please open an issue on GitHub
R
Rich Salz 已提交
10

11 12 13 14
To submit a patch, please open a pull request on GitHub.  If you are thinking
of making a large contribution, open an issue for it before starting work,
to get comments from the community.  Someone may be already working on
the same thing or there may be reasons why that feature isn't implemented.
R
Rich Salz 已提交
15

16 17 18 19 20 21 22 23
To make it easier to review and accept your pull request, please follow these
guidelines:

    1. Anything other than a trivial contribution requires a Contributor
    License Agreement (CLA), giving us permission to use your code. See
    https://www.openssl.org/policies/cla.html for details.  If your
    contribution is too small to require a CLA, put "CLA: trivial" on a
    line by itself in your commit message body.
R
Rich Salz 已提交
24 25 26 27 28 29 30 31 32 33 34 35

    2.  All source files should start with the following text (with
    appropriate comment characters at the start of each line and the
    year(s) updated):

        Copyright 20xx-20yy The OpenSSL Project Authors. All Rights Reserved.

        Licensed under the OpenSSL license (the "License").  You may not use
        this file except in compliance with the License.  You can obtain a copy
        in the file LICENSE in the source distribution or at
        https://www.openssl.org/source/license.html

R
Rich Salz 已提交
36
    3.  Patches should be as current as possible; expect to have to rebase
37 38
    often. We do not accept merge commits, you will have to remove them
    (usually by rebasing) before it will be acceptable.
R
Rich Salz 已提交
39

M
Matt Caswell 已提交
40
    4.  Patches should follow our coding style (see
41 42
    https://www.openssl.org/policies/codingstyle.html) and compile
    without warnings. Where gcc or clang is available you should use the
M
Matt Caswell 已提交
43
    --strict-warnings Configure option.  OpenSSL compiles on many varied
44 45 46
    platforms: try to ensure you only use portable features.  Clean builds
    via Travis and AppVeyor are required, and they are started automatically
    whenever a PR is created or updated.
R
Rich Salz 已提交
47

R
Rich Salz 已提交
48 49 50
    5.  When at all possible, patches should include tests. These can
    either be added to an existing test, or completely new.  Please see
    test/README for information on the test framework.
51

R
Rich Salz 已提交
52
    6.  New features or changed functionality must include
53 54 55
    documentation. Please look at the "pod" files in doc/man[1357] for
    examples of our style. Run "make doc-nits" to make sure that your
    documentation changes are clean.