Re: [PATCH] Update based on suggestions by Petr Baudis

From: Nicolas Pitre <nico@fluxnic.net>
Date: Apr 22, 2010, 03:20 UTC
Message-ID: <alpine.LFD.2.00.1004212304510.7232@xanadu.home>
In-Reply-To: <20100422020746.5205B475FF1@snark.thyrsus.com>

On Wed, 21 Apr 2010, Eric Raymond wrote:

> ---
>  contrib/ciabot/ciabot.py |  130 +++++++++++++++++++++++++---------------------
>  contrib/ciabot/ciabot.sh |  106 +++++++++++++++++++++----------------
>  2 files changed, 130 insertions(+), 106 deletions(-)

[...]

That would be better if you improve your patch message a bit.

First, the email subject is used by tools to provide a summary line for the changes. Example:

[PATCH] improvements to the ciabot scripts

Then, in the email body you may add more information, such as a more elaborate explanation of the change. It is also where such credits as "Update based on suggestions by Petr Baudis" should go.

If you want to add further comments that should not be part of the commit log, then just place them after the three-dash line.

When making a commit with Git, the convention is to use the very first line of the commit message for the summary line (without the [PATCH] prefix), then a blank line separating it from the rest of the commit message. This way tools such as 'git format-patch' or 'git send-email' will do the right thing automatically.

Finally, your patch description message should also include a Signed-off-by tag as explained in Documentation/SubmittingPatches.

Nicolas