mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2024-11-30 22:20:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

CONTRIBUTING.md: emphasize image caption

Browse source 
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 <rybak.a.v@gmail.com>
This commit is contained in:
Andrei Rybak 2023-01-14 15:19:47 +01:00 committed by Dirk Hohndel
parent 43cdcd0c4b
commit 4996d90d53
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -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: