]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
CONTRIBUTE: fix syntax in commit message description
authorAndrei Rybak <rybak.a.v@gmail.com>
Sun, 23 Jul 2023 21:32:45 +0000 (23:32 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Sun, 23 Jul 2023 21:47:16 +0000 (23:47 +0200)
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

index 77d929f0d4f0be221aae0073c5aab7f36d979484..605e55a5d00a2d6099fd059b767da67cf9dce0a5 100644 (file)
@@ -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:,