1- HOW TO CONTRIBUTE PATCHES TO OpenSSL
2- ------------------------------------
1+ HOW TO CONTRIBUTE TO OpenSSL
2+ ----------------------------
33
44(Please visit https://www.openssl.org/community/getting-started.html for
55other ideas about how to contribute.)
66
7- Development is coordinated on the openssl-dev mailing list (see the
8- above link or https://mta.openssl.org for information on subscribing).
9- If you are unsure as to whether a feature will be useful for the general
10- OpenSSL community you might want to discuss it on the openssl-dev mailing
11- list first. Someone may be already working on the same thing or there
12- may be a good reason as to why that feature isn't implemented.
7+ Development is done on GitHub, https://github.com/openssl/openssl.
138
14- To submit a patch, make a pull request on GitHub. If you think the patch
15- could use feedback from the community, please start a thread on openssl-dev
16- to discuss it.
9+ To request new features or report bugs, please open an issue on GitHub
1710
18- Having addressed the following items before the PR will help make the
19- acceptance and review process faster:
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.
2015
21- 1. Anything other than trivial contributions will require a contributor
22- licensing agreement, giving us permission to use your code. See
23- https://www.openssl.org/policies/cla.html for details.
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.
2424
2525 2. All source files should start with the following text (with
2626 appropriate comment characters at the start of each line and the
@@ -34,21 +34,38 @@ acceptance and review process faster:
3434 https://www.openssl.org/source/license.html
3535
3636 3. Patches should be as current as possible; expect to have to rebase
37- often. We do not accept merge commits; You will be asked to remove
38- them before a patch is considered acceptable.
37+ often. We do not accept merge commits, you will have to remove them
38+ (usually by rebasing) before it will be acceptable.
3939
4040 4. Patches should follow our coding style (see
41- https://www.openssl.org/policies/codingstyle.html) and compile without
42- warnings. Where gcc or clang is available you should use the
41+ https://www.openssl.org/policies/codingstyle.html) and compile
42+ without warnings. Where gcc or clang is available you should use the
4343 --strict-warnings Configure option. OpenSSL compiles on many varied
44- platforms: try to ensure you only use portable features.
45- Clean builds via Travis and AppVeyor are expected , and done whenever
46- a PR is created or updated.
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.
4747
4848 5. When at all possible, patches should include tests. These can
4949 either be added to an existing test, or completely new. Please see
5050 test/README for information on the test framework.
5151
5252 6. New features or changed functionality must include
53- documentation. Please look at the "pod" files in doc/apps, doc/crypto
54- and doc/ssl for examples of our style.
53+ documentation. Please look at the "pod" files in doc for
54+ examples of our style.
55+
56+ 7. For user visible changes (API changes, behaviour changes, ...),
57+ consider adding a note in CHANGES. This could be a summarising
58+ description of the change, and could explain the grander details.
59+ Have a look through existing entries for inspiration.
60+ Please note that this is NOT simply a copy of git-log oneliners.
61+ Also note that security fixes get an entry in CHANGES.
62+ This file helps users get more in depth information of what comes
63+ with a specific release without having to sift through the higher
64+ noise ratio in git-log.
65+
66+ 8. For larger or more important user visible changes, as well as
67+ security fixes, please add a line in NEWS. On exception, it might be
68+ worth adding a multi-line entry (such as the entry that announces all
69+ the types that became opaque with OpenSSL 1.1.0).
70+ This file helps users get a very quick summary of what comes with a
71+ specific release, to see if an upgrade is worth the effort.
0 commit comments