[PATCH] Begin SubmittingPatches with a check list

From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: Mar 5, 2007, 15:37 UTC
Message-ID: <Pine.LNX.4.63.0703051631350.22628@wbgn013.biozentrum.uni-wuerzburg.de>
In-Reply-To: <20070305150418.GD3481@diana.vm.bytemark.co.uk>

It seems that some people prefer a short list to a long text. But even for the latter group, a quick reminder list is useful. So, add a check list to Documentation/SubmittingPatches of what to do to get your patch accepted.

Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>

---

	On Mon, 5 Mar 2007, Karl Hasselström wrote:

	> On 2007-03-05 15:54:46 +0100, Johannes Schindelin wrote:
	> 
	> > On Mon, 5 Mar 2007, Karl Hasselström wrote:
	> >
	> > > Yes, Documentation/SubmittingPatches is a loooong text ...
	> >
	> > Unless you count all the MUA specific things, it is just 162
	> > lines...
	> 
	> There's still a lot of information in there. It's not hard to 
	> forget one out of the ~28 paragraphs of non-MUA-specific info.

 Documentation/SubmittingPatches |   25 +++++++++++++++++++++++++
 1 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 285781d..b6b3dd5 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -1,3 +1,28 @@
+Short version for the impatient:
+
+	- 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
+	- provide a meaningful commit message
+	- the first line of the commit message should be a short
+	  description and should skip the full stop
+	- if you want your work included in git.git, add a
+	  "Signed-off-by: Your Name <your@email.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
+	- do not PGP sign your patch
+	- use "git format-patch -M" to create the patch
+	- do not attach your patch, but paste it in the mail
+	  mail body, unless you cannot teach your mailer to
+	  leave the formatting of the patch alone
+	- provide additional information (which is unsuitable for
+	  the commit message) between the "---" and the diffstat
+	- send the patch to the list _and_ the maintainer
+
+Long version:
+
 I started reading over the SubmittingPatches document for Linux
 kernel, primarily because I wanted to have a document similar to
 it for the core GIT to make sure people understand what they are