add doc/SubmittingPatches
authorSven Verdoolaege <skimo@kotnet.org>
Sun, 10 Jul 2011 06:34:37 +0000 (08:34 +0200)
committerSven Verdoolaege <skimo@kotnet.org>
Sun, 10 Jul 2011 06:35:11 +0000 (08:35 +0200)
Signed-off-by: Sven Verdoolaege <skimo@kotnet.org>
doc/SubmittingPatches [new file with mode: 0644]

diff --git a/doc/SubmittingPatches b/doc/SubmittingPatches
new file mode 100644 (file)
index 0000000..7283aa3
--- /dev/null
@@ -0,0 +1,41 @@
+[Mostly copied from git's SubmittingPatches]
+
+       Commits:
+
+       - make commits of logical units
+       - check for unnecessary whitespace with "git diff --check"
+         before committing
+       - do not check in commented out code or unneeded files
+       - the first line of the commit message should be a short
+         description and should skip the full stop
+       - the body should provide a meaningful commit message, which
+         includes motivation for the change, and contrasts
+         its implementation with previous behaviour
+       - if you want your work included in isl.git, add a
+         "Signed-off-by: Your Name <you@example.com>" line to the
+         commit message (or just use the option "-s" when
+         committing) to confirm that you agree to the Developer's
+         Certificate of Origin
+       - make sure that you have tests for the bug you are fixing
+       - make sure that the test suite passes after your commit
+
+       Patch:
+
+       - use "git format-patch -M" to create the patch
+       - do not PGP sign your patch
+       - do not attach your patch, but read in the mail
+         body, unless you cannot teach your mailer to
+         leave the formatting of the patch alone.
+       - be careful doing cut & paste into your mailer, not to
+         corrupt whitespaces.
+       - provide additional information (which is unsuitable for
+         the commit message) between the "---" and the diffstat
+       - if you change, add, or remove a command line option or
+         make some other user interface change, the associated
+         documentation should be updated as well.
+       - if your name is not writable in ASCII, make sure that
+         you send off a message in the correct encoding.
+       - send the patch to the development mailing list
+         (isl-development@googlegroups.co).  If you use
+         git-send-email(1), please test it first by sending email
+         to yourself.