doc: Deal with paragraphes in trailers

Git trailers have a funny format Signed-off-by: Ivan Enderlin <[email protected]>
matrix-org · Oct 29, 2024 · c2469ab · c2469ab
1 parent 5f0ba1e
commit c2469ab
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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 two whitespaces after new lines to create a paragraph.
+
 ### Security fixes
 
 Commits addressing security vulnerabilities must include specific trailers for