Re: contrib/ area

From: Junio C Hamano <junkio@cox.net>
Date: Feb 18, 2006, 09:02 UTC
Message-ID: <7v1wy1qbt2.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <cc723f590602180038i4186b38axa1cc7e06be385da0@mail.gmail.com>

"Aneesh Kumar" <aneesh.kumar@gmail.com> writes:

> How about sending the patches as attachment below. I am not sure how
> to inline patches in gmail.

For some reason, attachment is usually frowned upon, but if you cannot do anything else, then at least please do _not_ hide the commit log message in the attachment.

The short description of the patch should be on the Subject: line. Make sure it makes sense if your short description appeared in "git log --pretty=short" output without the rest of the commit log message. "Fix a typo" is an example of bad description -- you cannot tell typo in what part of the tree was fixed by the commit.

And the rest of the log message, including the sign-off, should be in the main text. Also short administrative message should come *after* the three-dash separators.

So, I would have done the message I am replying to like this:

***	From: "Aneesh Kumar" <aneesh.kumar@gmail.com>
	To: gitster
	cc: git@vger.kernel.org
        Subject: gitview: typofix in documentation
***	Date: Sat Feb 18 13:54:50 2006 +0530

	I forgot to change the name of the program when I copy &
	pasted.

	Signed-off-by: An Ku <an.ku@g.com>

---

          On 2/18/06, Junio C Hamano <junkio@cox.net> wrote:
          > Aneesh Kumar <aneesh.kumar@gmail.com> writes:
          >
          > > Attaching below the same in the form of patch genera...
          >
          > I'll let it pass this time, but you forgot a sign-off ...
          > perhaps forgot to read Documentation/SubmittingPatches...
          >

          How about sending the patches as attachment below. I am not
          sure how to inline patches in gmail.

          -aneesh

	[git-diff output comes here, preferrably inline but
	 otherwise as a text/plain attachment.]

Let your MUA fill in *** lines. You _could_ override them with the first lines of the _body_ of your message like this if you really need it. Most of the time you shouldn't care.

***	From: "Aneesh Kumar" <aneesh.kumar@gmail.com>
	To: gitster
	cc: git@vger.kernel.org
        Subject: gitview: typofix in documentation
***	Date: Sat Feb 18 13:54:50 2006 +0530

	From: "An Ku" <an.ku@gmail.com>
        Date: Fri Feb 17 10:00:00 2006 +0530

	I forgot to change the name of the program when I copy &
	pasted.

	Signed-off-by: An Ku <an.ku@g.com>

	---
	...