[thirdparty/openssl.git] / CONTRIBUTING

HOW TO CONTRIBUTE TO OpenSSL
----------------------------

(Please visit https://www.openssl.org/community/getting-started.html for
other ideas about how to contribute.)

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

To request new features or report bugs, please open an issue on GitHub

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.

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.

    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

    3.  Patches should be as current as possible; expect to have to rebase
    often. We do not accept merge commits, you will have to remove them
    (usually by rebasing) before it will be acceptable.

    4.  Patches should follow our coding style (see
    https://www.openssl.org/policies/codingstyle.html) and compile
    without warnings. Where gcc or clang is available you should use the
    --strict-warnings Configure option.  OpenSSL compiles on many varied
    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.

    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.

    6.  New features or changed functionality must include
    documentation. Please look at the "pod" files in doc for
    examples of our style.
Commit	Line	Data
06196e71 RS	1	HOW TO CONTRIBUTE TO OpenSSL
06196e71 RS	2	----------------------------
706c85da	3
733f72f1	4	(Please visit https://www.openssl.org/community/getting-started.html for
c393a5de	5	other ideas about how to contribute.)
706c85da	6
06196e71	7	Development is done on GitHub, https://github.com/openssl/openssl.
706c85da	8
06196e71	9	To request new features or report bugs, please open an issue on GitHub
706c85da	10
06196e71 RS	11	To submit a patch, please open a pull request on GitHub. If you are thinking
	12	of making a large contribution, open an issue for it before starting work,
	13	to get comments from the community. Someone may be already working on
	14	the same thing or there may be reasons why that feature isn't implemented.
c393a5de	15
06196e71 RS	16	To make it easier to review and accept your pull request, please follow these
	17	guidelines:
	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.
c393a5de RS	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
e8e380ce	36	3. Patches should be as current as possible; expect to have to rebase
06196e71 RS	37	often. We do not accept merge commits, you will have to remove them
06196e71 RS	38	(usually by rebasing) before it will be acceptable.
c393a5de	39
733f72f1	40	4. Patches should follow our coding style (see
06196e71 RS	41	https://www.openssl.org/policies/codingstyle.html) and compile
06196e71 RS	42	without warnings. Where gcc or clang is available you should use the
733f72f1	43	--strict-warnings Configure option. OpenSSL compiles on many varied
06196e71 RS	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.
c393a5de	47
e8e380ce RS	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.
733f72f1	51
e8e380ce	52	6. New features or changed functionality must include
06196e71 RS	53	documentation. Please look at the "pod" files in doc for
06196e71 RS	54	examples of our style.