diff options
author | Richard Levitte <levitte@openssl.org> | 2018-05-14 05:38:59 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2018-05-17 13:51:11 +0200 |
commit | 029c11c21fdd018ec51badaafd34118223055274 (patch) | |
tree | 4e35d05bc2ec78c9a132e2b93f055f2e35511fbd /CONTRIBUTING | |
parent | 8d483b2de78619e8592f2558301f3295daf59690 (diff) |
Add a note on CHANGES and NEWS in CONTRIBUTING
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/6249)
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r-- | CONTRIBUTING | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index 76548624dd..c0eed39e34 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -53,3 +53,20 @@ guidelines: 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. |