From bec625eb013076e7839a8ff54b0a53c28d54890f Mon Sep 17 00:00:00 2001 From: Andrei Rybak Date: Sat, 14 Jan 2023 14:36:03 +0100 Subject: [PATCH] CONTRIBUTING.md: format filenames in monospace Wrap filenames in paragraphs in `CONTRIBUTING.md` in backticks to render them in monospace font. Fix an accidental double space before the reference to `CHANGELOG.md`, while we're here. Signed-off-by: Andrei Rybak --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 553d7bb6d..2a8a237db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ If you want to change the commit message, `git commit --amend` is the way to go. git format-patch master..devel -Which creates a number of files that have names like 0001-Commit-title.patch, which you can then send to our developer mailing list. +Which creates a number of files that have names like `0001-Commit-title.patch`, which you can then send to our developer mailing list. When sending code, please either send signed-off patches or a pull request with signed-off commits. If you don't sign off on them, we will not accept them. This means adding a line that says "Signed-off-by: Name \" at the end of each commit, indicating that you wrote the code and have the right to pass it on as an open source patch. @@ -62,7 +62,7 @@ https://en.wikipedia.org/wiki/Imperative_mood 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: +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: Area: Details about the change [reference thread / issue]