Skip to content

Commit

Permalink
Update contributing.md (#1227)
Browse files Browse the repository at this point in the history
Need to escape \< and \> in the sign off message format so users see them explicitly in the Contributing to the Documentation section. 

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>
  • Loading branch information
theiding committed Jun 16, 2020
1 parent e85faf0 commit 942580d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion developers/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ You don't even need to know Git.
* You can preview your changes under the "Preview changes" tab.
* Add a title and optional description for your proposed change at the bottom of the editor.
* The [sign off rules](#sign-your-work) described above do apply to documentation contributions as well.
Simply add an empty line and the sign off statement "Signed-off-by: Joe Smith <joe.smith@email.com>" at the end of your change description at the bottom of the editor.
Simply add an empty line and the sign off statement "Signed-off-by: Joe Smith \<joe.smith@email.com\>" at the end of your change description at the bottom of the editor.
Note that as per the rules you have to provide your full name in the sign off and that full name has to match the name you configured in your GitHub profile for the DCO check to succeed.
* Click the "Propose file change" button at the bottom of the editor.

Expand Down

0 comments on commit 942580d

Please sign in to comment.