From 971f03e5c0d1fdb8523a5f33190dfc44e542d188 Mon Sep 17 00:00:00 2001 From: Andrei Rybak Date: Sun, 23 Jul 2023 23:32:45 +0200 Subject: [PATCH] CONTRIBUTE: fix syntax in commit message description File 'docs/CONTRIBUTE.md' includes a description of how one should write commit messages in the curl project. Different possible parts of the message are enclosed in square brackets. One exception is the section describing how the curl project doesn't use "Signed-off-by" commit trailers [1], which is enclosed in an opening curly brace paired with a closing square bracket. Fix the enclosing square brackets in description of "Signed-off-by" trailers in commit messages in file 'docs/CONTRIBUTE.md'. [1] See description of option '--signoff' in Git documentation: https://git-scm.com/docs/git-commit Closes #11504 --- docs/CONTRIBUTE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md index 77d929f0d4..605e55a5d0 100644 --- a/docs/CONTRIBUTE.md +++ b/docs/CONTRIBUTE.md @@ -210,7 +210,7 @@ A short guide to how to write git commit messages in the curl project. as you are implicitly approving it by committing] [Authored-by: John Doe - credit the original author of the code; only use this if you can't use "git commit --author=..."] - {Signed-off-by: John Doe - we don't use this, but don't bother removing it] + [Signed-off-by: John Doe - we don't use this, but don't bother removing it] [whatever-else-by: credit all helpers, finders, doers; try to use one of the following keywords if at all possible, for consistency: Acked-by:, Assisted-by:, Co-authored-by:, Found-by:, Reported-by:,