yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #3726 from gilles-peskine-arm/changelog-user-visible-only-development

Browse source 
Only use ChangeLog to inform users, not for acknowledgement
This commit is contained in:
Janos Follath 2020-10-01 11:37:22 +01:00 committed by GitHub
commit 2cb88c9a24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
ChangeLog.d/00README.md
View file

@ -3,6 +3,29 @@
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 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.
We generally don't include changelog entries for:
* Documentation improvements.
* Performance improvements, unless they are particularly significant.
* 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.24.0, 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 +56,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
@ -49,8 +71,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

2
ChangeLog.d/comment_typo_in_mbedtls_ssl_set_bio.txt
View file

@ -1,2 +0,0 @@
Changes
* Fix comment typo in documentation of mbedtls_ssl_set_bio.

3
ChangeLog.d/fix-typo.txt
View file

@ -1,3 +0,0 @@
Changes
* Fixes a typo in the example code located in
program/pkey/ecdh_curve25519.c