mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2024-11-30 22:20:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add/clarify email requirement to contribution documentation.

Browse source 
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>
This commit is contained in:
John Plaxco 2018-12-23 07:38:11 -05:00 committed by Dirk Hohndel
parent 5c0497e14b
commit 95736506fe
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -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` `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. 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] 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. nicely even when it's indented.
Reported-by: whoever-reported-it 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. 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.

2
README.md
View file

@ -134,7 +134,7 @@ future self can read the patch, but might not understand why a
particular solution was implemented. particular solution was implemented.
Reported-by: whoever-reported-it 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 where that header line really should be meaningful, and really should be