diff options
Diffstat (limited to 'crypto/openssl/CONTRIBUTING')
| -rw-r--r-- | crypto/openssl/CONTRIBUTING | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/crypto/openssl/CONTRIBUTING b/crypto/openssl/CONTRIBUTING index efcb0b84488d..c0eed39e34b2 100644 --- a/crypto/openssl/CONTRIBUTING +++ b/crypto/openssl/CONTRIBUTING @@ -50,5 +50,23 @@ guidelines: 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. + 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. |