diff options
| author |  John Plaxco <john@johnplaxco.com> | 2018-12-23 07:38:11 -0500 |
|---|---|---|
| committer |  Dirk Hohndel <dirk@hohndel.org> | 2018-12-23 19:59:47 +0100 |
| commit | 95736506fe10fdc4fb5facaf2bd2dac5c4b179da (patch) | |
| tree | 4dd27100bb7924929d0016542614f1f43abf85f7 | |
| parent | 5c0497e14b57a6ee420f4383e3cf72ac5a445064 (diff) | |
| download | subsurface-95736506fe10fdc4fb5facaf2bd2dac5c4b179da.tar.gz | |
Add/clarify email requirement to contribution documentation.
Make it easier for new contributors to get going by making the
Signed-off-by line more clearly explained.
Signed-off-by: John Plaxco <john@johnplaxco.com>
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | README.md | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a923918b5..6d80021d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,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. -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. +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 \<Email\>" 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. See: [Signed-off-by Lines][9] @@ -43,7 +43,7 @@ please do proper word-wrap and keep columns shorter than about nicely even when it's indented. Reported-by: whoever-reported-it -Signed-off-by: Your Name +Signed-off-by: Your Name \<you@example.com\> That header line really should be meaningful, and really should be just one line. The header line is what is shown by tools like gitk and shortlog, and should summarize the change in one readable line of text, independently of the longer explanation. @@ -134,7 +134,7 @@ future self can read the patch, but might not understand why a particular solution was implemented. Reported-by: whoever-reported-it -Signed-off-by: Your Name <youremail@yourhost.com> +Signed-off-by: Your Name <you@example.com> ``` where that header line really should be meaningful, and really should be |