The branch OpenSSL_1_1_0-stable has been updated
       via  fca038db55be460d7751910a03e550ba659d3c4f (commit)
      from  0bde96f13837825fa899573728899744a956beff (commit)


- Log -----------------------------------------------------------------
commit fca038db55be460d7751910a03e550ba659d3c4f
Author: Richard Levitte <levi...@openssl.org>
Date:   Mon May 14 05:38:59 2018 +0200

    Add a note on CHANGES and NEWS in CONTRIBUTING
    
    Reviewed-by: Matthias St. Pierre <matthias.st.pie...@ncp-e.com>
    (Merged from https://github.com/openssl/openssl/pull/6249)
    
    (cherry picked from commit 029c11c21fdd018ec51badaafd34118223055274)

-----------------------------------------------------------------------

Summary of changes:
 CONTRIBUTING | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/CONTRIBUTING b/CONTRIBUTING
index efcb0b8..a6977b8 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -52,3 +52,20 @@ guidelines:
     6.  New features or changed functionality must include
     documentation. Please look at the "pod" files in doc for
     examples of our style.
+
+    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.
_____
openssl-commits mailing list
To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-commits

Reply via email to