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.
+ contribution is too small to require a CLA (e.g. fixing a spelling
+ mistake), place the text "CLA: trivial" on a line by itself separated by
+ an empty line from the rest of the commit message. It is not sufficient to
+ only place the text in the GitHub pull request description.
+
+ To amend a missing "CLA: trivial" line after submission, do the following:
+
+ git commit --amend
+ [add the line, save and quit the editor]
+ git push -f
2. All source files should start with the following text (with
appropriate comment characters at the start of each line and the
Copyright 20xx-20yy The OpenSSL Project Authors. All Rights Reserved.
- Licensed under the OpenSSL license (the "License"). You may not use
+ 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
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.