]> git.tdb.fi Git - ext/subsurface.git/blobdiff - README
Libdivecomputer: start actually importing the dive data
[ext/subsurface.git] / README
diff --git a/README b/README
index 0ff77c375e82c7957b9c8c935498a9934698c065..527bdb345d1067e55ab00a56606856b7aa83ec4e 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ I'm tired of java programs that don't work etc.
 
 License: GPLv2
 
-You need libxml2-devel and gtk2-devel to build this.
+You need libxml2-devel, gtk2-devel and GConf2-devel to build this.
 
 Usage:
 
@@ -38,3 +38,35 @@ 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
+
+Also, please write good git commit messages.  A good commit message
+looks like this:
+
+       header line: explaining the commit in one line
+
+       Body of commit message is a few lines of text, explaining things
+       in more detail, possibly giving some background about the issue
+       being fixed, etc etc.
+
+       The body of the commit message can be several paragrahps, and
+       please do proper word-wrap and keep columns shorter than about
+       74 characters or so. That way "git log" will show things
+       nicely even when it's indented.
+
+       Reported-by: whoever-reported-it
+       Signed-off-by: Your Name <youremail@yourhost.com>
+
+where that header line really should be meaningful, and really should be
+just one line.  That 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.