X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=CONTRIBUTING;h=250bbdbf24f96fb2224cb87757e089f83a1a5c5c;hp=a04dbea90cfa2a707c1e563bf2891e0471332eab;hb=70c35fd1f6467da5563c6cab3ea373e6359cf080;hpb=eb05f17344c6538d9ee48770d963ae2c1822d070 diff --git a/CONTRIBUTING b/CONTRIBUTING index a04dbea90c..250bbdbf24 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,43 +1,72 @@ HOW TO CONTRIBUTE TO OpenSSL ---------------------------- -Development is coordinated on the openssl-dev mailing list (see -http://www.openssl.org for information on subscribing). If you -would like to submit a patch, send it to rt@openssl.org with -the string "[PATCH]" in the subject. Please be sure to include a -textual explanation of what your patch does. - -You can also make GitHub pull requests. If you do this, please also send mail to -rt@openssl.org with a brief description and a link to the PR so that we can more -easily keep track of it. - -If you are unsure as to whether a feature will be useful for the general -OpenSSL community please discuss it on the openssl-dev mailing list first. -Someone may be already working on the same thing or there may be a good -reason as to why that feature isn't implemented. - -Patches should be as up to date as possible, preferably relative to the -current Git or the last snapshot. They should follow our coding style -(see https://www.openssl.org/policies/codingstyle.html) and compile without -warnings using the --strict-warnings flag. OpenSSL compiles on many -varied platforms: try to ensure you only use portable features. - -Note: For legal reasons, contributions from the US can be accepted only -if a TSU notification and a copy of the patch are sent to crypt@bis.doc.gov -(formerly BXA) with a copy to the ENC Encryption Request Coordinator; -please take some time to look at -http://www.bis.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html [sic] -and -http://w3.access.gpo.gov/bis/ear/pdf/740.pdf (EAR Section 740.13(e)) -for the details. If "your encryption source code is too large to serve as -an email attachment", they are glad to receive it by fax instead; hope you -have a cheap long-distance plan. - -Our preferred format for changes is "diff -u" output. You might -generate it like this: - -# cd openssl-work -# [your changes] -# ./Configure dist; make clean -# cd .. -# diff -ur openssl-orig openssl-work > mydiffs.patch +(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 Apache License 2.0 (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/man[1357] for + examples of our style. Run "make doc-nits" to make sure that your + documentation changes are clean. + + 7. For user visible changes (API changes, behaviour changes, ...), + consider adding a note in CHANGES. This could be a summarising + description of the change, and could explain the grander details. + Have a look through existing entries for inspiration. + Please note that this is NOT simply a copy of git-log oneliners. + Also note that security fixes get an entry in CHANGES. + This file helps users get more in depth information of what comes + with a specific release without having to sift through the higher + noise ratio in git-log. + + 8. For larger or more important user visible changes, as well as + security fixes, please add a line in NEWS. On exception, it might be + worth adding a multi-line entry (such as the entry that announces all + the types that became opaque with OpenSSL 1.1.0). + This file helps users get a very quick summary of what comes with a + specific release, to see if an upgrade is worth the effort.