mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2025-01-26 02:30:59 +00:00
Explain when to write a changelog entry
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
parent
36c2ea5376
commit
27db5e4405
|
@ -3,6 +3,28 @@
|
||||||
This directory contains changelog entries that have not yet been merged
|
This directory contains changelog entries that have not yet been merged
|
||||||
to the changelog file ([`../ChangeLog`](../ChangeLog)).
|
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.16.8, 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
|
## Changelog entry file format
|
||||||
|
|
||||||
A changelog entry file must have the extension `*.txt` and must have the
|
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
|
Bugfix
|
||||||
Changes
|
Changes
|
||||||
|
|
||||||
Use “Changes” for anything that doesn't fit in the other categories, such as
|
Use “Changes” for anything that doesn't fit in the other categories.
|
||||||
performance, documentation and test improvements.
|
|
||||||
|
|
||||||
## How to write a changelog entry
|
## How to write a changelog entry
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue