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: Andrew Atkinson <andyatkinson@gmail.com>, pgsql-hackers@postgresql.org, samay@tembo.io
Date: 2024-02-26T20:30:36Z
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:
> I think this would be nice.  If the Markdown version is reasonably readable
> as plain-text, maybe we could avoid maintaining two READMEs files, too.
> But overall, +1 to modernizing the README a bit.

Per past track record, we change the top-level README only once every
three years or so, so I doubt it'd be too painful to maintain two
versions of it.

Having said that, any proposal for this ought to be submitted as
a patch, rather than expecting people to go digging around on
some other repo.

			regards, tom lane