Re: Tips on committing

From: Peter Geoghegan <pg(at)bowt(dot)ie>
To: Noah Misch <noah(at)leadboat(dot)com>
Cc: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, Bruce Momjian <bruce(at)momjian(dot)us>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>, Pg Committers <pgsql-committers(at)postgresql(dot)org>
Subject: Re: Tips on committing
Date: 2018-07-11 23:35:33
Message-ID: CAH2-WzmiyqnpF5b9Psk0X-Rn7omrpjP5CONzMX+jYzcN6Z44Sw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-hackers

On Tue, Jul 10, 2018 at 9:14 PM, Noah Misch <noah(at)leadboat(dot)com> wrote:
> My rule has been to add to my private checklist anytime I mail or push a patch
> containing a readily-checkable mistake. I go through the checklist before
> mailing or pushing any patch. It has things in common with your list, plus
> these:
>
> * Validate err*() calls against https://www.postgresql.org/docs/devel/static/error-style-guide.html
> * Validate *printf calls for trailing newlines
>
> * Spellcheck the patch
>
> * Verify long lines are not better broken
> git diff origin/master | grep -E '^(\+|diff)' | sed 's/^+//' | expand -t4 | awk "length > 78 || /^diff/"
>
> * Run pgindent on changed files; keep the changes I made necessary
>
> * Update version numbers, if needed
> CATALOG_VERSION_NO, PG_CONTROL_VERSION, XLOG_PAGE_MAGIC, PGSTAT_FILE_FORMAT_ID

I'm going to use some of these, myself.

>> I'll try to do that, but I'd still recommend personalizing it. A lot
>> of the stuff in there is specific to my own workflow and tool
>> preferences, and my own personal working style.
>
> I agree we won't all want the exact same checklist. Still, it wouldn't hurt
> to have a wiki page of checklist entry ideas from which folks cherry-pick the
> entries they like.

You've convinced me that we should definitely have such a list. I've
put it on my TODO list.

--
Peter Geoghegan

In response to

Responses

Browse pgsql-committers by date

  From Date Subject
Next Message Michael Paquier 2018-07-12 01:21:42 pgsql: Make logical WAL sender report streaming state appropriately
Previous Message Tom Lane 2018-07-11 22:47:40 pgsql: Mark built-in btree comparison functions as leakproof where it's

Browse pgsql-hackers by date

  From Date Subject
Next Message Haribabu Kommi 2018-07-12 00:19:29 Re: Accounting of zero-filled buffers in EXPLAIN (BUFFERS)
Previous Message Peter Geoghegan 2018-07-11 23:08:41 Re: [HACKERS] autovacuum can't keep up, bloat just continues to rise