Tips on committing

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: PostgreSQL-Committers <pgsql-committers(at)postgresql(dot)org>
Subject: Tips on committing
Date: 2018-06-28 13:26:13
Message-ID: 20180628132613.GA18214@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-hackers

With seven new committers, I thought it would be good for me to give
some tips I use in committing. I use a standard template that is this:

1 |--- gitweb/email subject limit -----------------|-------------|

2 Reported-by:

3 Bug:

4 Discussion:

5 Author:

6 Reviewed-by:

7 Tested-by:

8 Backpatch-through:

Any items left unchanged are automatically removed.

Line 1 shows me the length limits for the first commit line which will
appear in gitweb and commit subject lines. I always try to fit in the
commit subject line limit but the gitweb limit is too small for me in
many cases. (I automatically remove the first line, though that once
failed recently.)

If line 4 is a URL, I shorten it with this script:

sed 's;http\(s\?\)://www\.postgresql\.org/message-id/;http\1://postgr.es/m/;gi' "$@"

If line 4 is a message-id, I convert it to a shortened URL:

sed '/https\?:\/\//!s;^\(Discussion:[ \t]*\)\((dot)*(at)(dot)*\)$;\1https://postgr.es/m/\2;g'

I check for files in the tree with 'rej' extensions, which might
indicate failed patch application.

I also remove repeated blank lines with:

cat --squeeze-blank

--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I. As I am, so you will be. +
+ Ancient Roman grave inscription +

Responses

Browse pgsql-committers by date

  From Date Subject
Next Message Alvaro Herrera 2018-06-28 15:14:38 Re: Tips on committing
Previous Message Bruce Momjian 2018-06-28 13:12:18 pgsql: doc: backpatch mention use of cross platform logical replication

Browse pgsql-hackers by date

  From Date Subject
Next Message Alexander Kuzmenkov 2018-06-28 14:23:25 Re: Generating partitioning tuple conversion maps faster
Previous Message Bruce Momjian 2018-06-28 13:12:18 Re: Does logical replication supports cross platform servers?