From a89b650314ecc1695820fb6aeb937ff569b81db1 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Wed, 30 Sep 2020 01:11:39 +0200 Subject: [PATCH 1/4] Remove changelog entries without a user-visible impact Signed-off-by: Gilles Peskine --- ChangeLog.d/comment_typo_in_mbedtls_ssl_set_bio.txt | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 ChangeLog.d/comment_typo_in_mbedtls_ssl_set_bio.txt diff --git a/ChangeLog.d/comment_typo_in_mbedtls_ssl_set_bio.txt b/ChangeLog.d/comment_typo_in_mbedtls_ssl_set_bio.txt deleted file mode 100644 index 2f94c1633..000000000 --- a/ChangeLog.d/comment_typo_in_mbedtls_ssl_set_bio.txt +++ /dev/null @@ -1,2 +0,0 @@ -Changes - * Fix comment typo in documentation of mbedtls_ssl_set_bio. From 57205b2297a8ed88745ac4a54a943ba44235a3b9 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Wed, 30 Sep 2020 01:13:05 +0200 Subject: [PATCH 2/4] We no longer credit contributors in the changelog From now on, external contributions are no longer acknowledged in the changelog file. They of course remain acknowledged in the Git history. Signed-off-by: Gilles Peskine --- ChangeLog.d/00README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/ChangeLog.d/00README.md b/ChangeLog.d/00README.md index b559e2336..abe0537ef 100644 --- a/ChangeLog.d/00README.md +++ b/ChangeLog.d/00README.md @@ -49,8 +49,7 @@ Include GitHub issue numbers where relevant. Use the format “#1234” for an Mbed TLS issue. Add other external references such as CVE numbers where applicable. -Credit the author of the contribution if the contribution is not a member of -the Mbed TLS development team. Also credit bug reporters where applicable. +Credit bug reporters where applicable. **Explain why, not how**. Remember that the audience is the users of the library, not its developers. In particular, for a bug fix, explain the From 1ffd967411cd1d874c4d76fc179f846572cf300c Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Wed, 30 Sep 2020 01:16:59 +0200 Subject: [PATCH 3/4] Explain when to write a changelog entry Signed-off-by: Gilles Peskine --- ChangeLog.d/00README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/ChangeLog.d/00README.md b/ChangeLog.d/00README.md index abe0537ef..67c47c5e0 100644 --- a/ChangeLog.d/00README.md +++ b/ChangeLog.d/00README.md @@ -3,6 +3,28 @@ This directory contains changelog entries that have not yet been merged to the changelog file ([`../ChangeLog`](../ChangeLog)). +## What requires a changelog entry? + +Write a changelog entry if there is a user-visible change. This includes: + +* Bug fixes: fixing a security hole, fixing broken behavior, fixing + the build in some configuration or on some platform, ... +* New features in the library or new platform support. +* Changes in existing behavior. These should be rare. Changes in features + that are documented as experimental may or may not be announced, depending + on the extent of the change and how widely we expect the feature to be used. + +We generally don't include changelog entries for: + +* Documentation improvements. +* Performance improvements, unless they are particularly significant. +* Changes that don't impact library users directly, for example new tests or + changes to the test framework. + +Until Mbed TLS 2.7.17, we required changelog entries in more cases. +Looking at older changelog entries is good practice for how to write a +changelog entry, but not for deciding whether to write one. + ## Changelog entry file format A changelog entry file must have the extension `*.txt` and must have the @@ -33,8 +55,7 @@ The permitted changelog entry categories are as follows: Bugfix Changes -Use “Changes” for anything that doesn't fit in the other categories, such as -performance, documentation and test improvements. +Use “Changes” for anything that doesn't fit in the other categories. ## How to write a changelog entry From 8c79c3f98540dbce07753ed46e948a1b7c11a822 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Wed, 30 Sep 2020 09:55:27 +0200 Subject: [PATCH 4/4] When to write a changelog: minor improvements Mention sample programs. Signed-off-by: Gilles Peskine --- ChangeLog.d/00README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/ChangeLog.d/00README.md b/ChangeLog.d/00README.md index 67c47c5e0..378619933 100644 --- a/ChangeLog.d/00README.md +++ b/ChangeLog.d/00README.md @@ -7,9 +7,10 @@ to the changelog file ([`../ChangeLog`](../ChangeLog)). Write a changelog entry if there is a user-visible change. This includes: -* Bug fixes: fixing a security hole, fixing broken behavior, fixing - the build in some configuration or on some platform, ... -* New features in the library or new platform support. +* Bug fixes in the library or in sample programs: fixing a security hole, + fixing broken behavior, fixing the build in some configuration or on some + platform, etc. +* New features in the library, new sample programs, or new platform support. * Changes in existing behavior. These should be rare. Changes in features that are documented as experimental may or may not be announced, depending on the extent of the change and how widely we expect the feature to be used. @@ -18,8 +19,8 @@ We generally don't include changelog entries for: * Documentation improvements. * Performance improvements, unless they are particularly significant. -* Changes that don't impact library users directly, for example new tests or - changes to the test framework. +* Changes to parts of the code base that users don't interact with directly, + such as test code and test data. Until Mbed TLS 2.7.17, we required changelog entries in more cases. Looking at older changelog entries is good practice for how to write a