yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-22 12:55:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

When to write a changelog: minor improvements

Browse Source 
Mention sample programs.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2020-09-30 09:55:27 +02:00
parent 27db5e4405
commit e1a7cad3c6
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ChangeLog.d/00README.md
View File

@ -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.16.8, we required changelog entries in more cases.
Looking at older changelog entries is good practice for how to write a