From 4996d90d53cf6bea7e0baf20923af686e781708b Mon Sep 17 00:00:00 2001 From: Andrei Rybak Date: Sat, 14 Jan 2023 15:19:47 +0100 Subject: [PATCH] CONTRIBUTING.md: emphasize image caption Markdown doesn't have a syntax for image captions. While we could use table syntax (an extension in GitHub's flavor of Markdown) to align the caption more clearly with the image, it wouldn't be very readable in plain text and Markdown renderers that don't have such an extension. Reduce confusion of readers by makimg the caption of the gitk screenshot formatted differently than the surrounding paragraphs. Use emphasis syntax for that. Signed-off-by: Andrei Rybak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ee7c8f73..b25c480ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ The preferred way to write a commit message is using [imperative mood][11], e.g. ![gitk sample][9] -Example with gitk +_Example with gitk_ Additionally when important changes to behaviors, fixes or new feature are introduced an entry must be added to `CHANGELOG.md` file. Always add new entries at the very top of the file above other existing entries. Use this layout for new entries: