]> git.tdb.fi Git - ext/subsurface.git/commitdiff
Add more explicit contributing explanation
authorScott Chacon <schacon@gmail.com>
Tue, 6 Sep 2011 19:32:51 +0000 (12:32 -0700)
committerScott Chacon <schacon@gmail.com>
Tue, 6 Sep 2011 19:33:52 +0000 (12:33 -0700)
Most developers on GitHub are not used to projects that use the Signed-off-by convention.
They do, however, tend to read the READMEs to see which conventions the author prefers
to follow.  If you are explicit about what you prefer in the README with easy to follow
instructions, it is more likely people will follow those conventions.

Signed-off-by: Scott Chacon <schacon@gmail.com>
README

diff --git a/README b/README
index 0ff77c375e82c7957b9c8c935498a9934698c065..19ddae26a27fa62ea642c0e445192c5385126e26 100644 (file)
--- a/README
+++ b/README
@@ -38,3 +38,14 @@ my divemaster course, so they are from following open water students
 along (many of them the confined*water dives).  There a lot of the
 action is at the surface, so some of the "dives" are 4ft deep and 2min
 long.
+
+Contributing:
+
+Please either send me signed-off patches or a pull request with
+signed-off commits.  If you don't sign off on them, I 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: http://gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html
+