Re: Credit in the release notes WAS: Draft release notes complete

From: Josh Berkus <josh(at)agliodbs(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Andrew Dunstan <andrew(at)dunslane(dot)net>, Robert Haas <robertmhaas(at)gmail(dot)com>, Alvaro Herrera <alvherre(at)commandprompt(dot)com>, PeterEisentraut <peter_e(at)gmx(dot)net>, Pg Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Credit in the release notes WAS: Draft release notes complete
Date: 2012-05-12 22:42:48
Message-ID: 4FAEE768.50204@agliodbs.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers


> How many names on a single item is ideal? The activity of reviewers and
> their names on commit messages has greatly expanded the number of
> potential names per item.
>
> How much of a downside is having the names in the release notes? For
> example, we decided that company names shouldn't be on release note
> items, so there is a case where we decided names were more of a negative
> than a positive. Are there other negatives? Do other project release
> notes have developer names? How are these names perceived by our
> general readers?

The two paragraphs above show the main problem.

Who gets listed on each item is a matter of some contention. For
example, if Robert Haas reviews a patch, and makes substantial
suggesitons and fixes to the patch, should he be listed on it as well?
If so, how much work is required for someone to be listed if they're not
the original author? What if we merge two patches, but take 90% of
Patch A and only 10% of Patch B? etc.

We can decide these things on a case-by-case basis, but it makes
preparing the release notes a LOT more effort.

Let's see what other OSS projects do:

HTTPD: lists people in the release notes:
http://www.apache.org/dist/httpd/CHANGES_2.4.2

Linux, as far as I can tell, does not do Release Notes as such.

FreeBSD does not have people's names in release notes, but does put
links to the relevant commitlog:
http://www.freebsd.org/releases/8.2R/relnotes.html

Drizzle puts author's names in the release notes:
http://blog.drizzle.org/category/release/

LibreOffice has author names and companies in the release notes:
http://www.libreoffice.org/download/3-4-new-features-and-fixes/

git does *not* put author names in the release notes:
https://raw.github.com/gitster/git/master/Documentation/RelNotes/1.7.9.txt

I don't know if any of the above are putting committer, or reviewer
names in the release notes, but given that most items have a single
name, I doubt it.

So what common practice tells us is inconclusive ...

--
Josh Berkus
PostgreSQL Experts Inc.
http://pgexperts.com

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Andrew Dunstan 2012-05-12 22:59:20 Re: Latch-ifying the syslogger process
Previous Message Peter Eisentraut 2012-05-12 20:21:29 Re: External Open Standards