From c48bb13159c90ee83b620bb91aacc6a4df6b36f3 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Tue, 29 Oct 2024 10:39:42 +0100 Subject: [PATCH] doc: Deal with paragraphes in trailers (#4179) Git trailers have a funny format. --------- Signed-off-by: Ivan Enderlin Co-authored-by: Benjamin Bouvier --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f56afd761..2e00b7eaf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,12 +93,14 @@ stringify Ed25519 and thus present them to users. It's also commonly used when Ed25519 keys need to be inserted into JSON. Changelog: Add the `Ed25519PublicKey::to_base64()` method which can be used to -stringify the Ed25519 public key. + stringify the Ed25519 public key. ``` In this commit message, the content specified in the `Changelog` trailer will be used for the changelog entry. +Be careful to add at least one whitespace after new lines to create a paragraph. + ### Security fixes Commits addressing security vulnerabilities must include specific trailers for