Horton

Re: An improved README experience for PostgreSQL

Tom Lane <tgl@sss.pgh.pa.us>

View thread
From: Tom Lane <tgl@sss.pgh.pa.us>
To: Nathan Bossart <nathandbossart@gmail.com>
Cc: Daniel Gustafsson <daniel@yesql.se>, Andrew Atkinson <andyatkinson@gmail.com>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, samay@tembo.io
Date: 2024-02-28T17:17:04Z
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 →

  1. Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, and SECURITY.md.

  2. Revise the style of a paragraph in README.md.

  3. Convert README to Markdown.

Nathan Bossart <nathandbossart@gmail.com> writes:
> Sorry, my suggestion wasn't meant to imply that I have any strong concerns
> about maintaining two README files.  If we can automate generating one or
> the other, that'd be great, but I don't see that as a prerequisite to
> adding a Markdown version.

Agreed, and I'd go so far as to say that adding automation now
would be investing work that might well go to waste.  When and
if we get annoyed by the manual labor involved in maintaining
two copies, it'd be time to put work into automating it.

			regards, tom lane