Re: An improved README experience for PostgreSQL

Nathan Bossart <nathandbossart@gmail.com>

From: Nathan Bossart <nathandbossart@gmail.com>

To: Peter Eisentraut <peter@eisentraut.org>

Cc: Alvaro Herrera <alvherre@alvh.no-ip.org>, Tom Lane <tgl@sss.pgh.pa.us>, Andrew Atkinson <andyatkinson@gmail.com>, "David E. Wheeler" <david@justatheory.com>, Joe Conway <mail@joeconway.com>, Daniel Gustafsson <daniel@yesql.se>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, Samay Sharma <samay@tembo.io>, andres@anarazel.de

Date: 2024-06-03T15:10:58Z

Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, and SECURITY.md.
- dec9d4acdb7d 18.0 landed
Revise the style of a paragraph in README.md.
- 84d80663199b 17.0 landed
Convert README to Markdown.
- 363eb059966d 17.0 landed

+Andres

On Thu, May 16, 2024 at 12:07:32PM +0200, Peter Eisentraut wrote:
> This patch version looks good to me.

At pgconf.dev, Andres opined that it would be better to put these files in
the top-level directory so that they would be more visible to non-GitHub
users.  I personally don't have any strong opinion on the matter, but I
will note that even though the files I have staged for commit are pretty
bare-bones, I do think we should eventually build on their content so that
they are more than just links to the website.  My goal here is to get
something basic in place so that future discussion can be focused on the
content.

Tom, Alvaro, and Peter have all expressed a preference to use the .github/
directory, so at the moment I still intend to proceed with the v3 patch
unless further discussion changes things.

-- 
nathan