Re: An improved README experience for PostgreSQL

Nathan Bossart <nathandbossart@gmail.com>

From: Nathan Bossart <nathandbossart@gmail.com>

To: Andrew Atkinson <andyatkinson@gmail.com>

Cc: pgsql-hackers@postgresql.org, samay@tembo.io

Date: 2024-02-26T18:30:18Z

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

On Mon, Feb 26, 2024 at 11:31:19AM -0600, Andrew Atkinson wrote:
> Hello Hackers. We’re proposing an improved README for PostgreSQL that
> includes more helpful links for prospective PostgreSQL contributors and has
> a nicer presentation.
> 
> Although development does not take place on GitHub or GitLab for
> PostgreSQL, many developers might view the PostgreSQL source code using one
> of those mirrors (I do myself). Since both support Markdown files, a
> Markdown version of the README (as README.md) gets presentational benefits
> that I think are helpful.

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.

-- 
Nathan Bossart
Amazon Web Services: https://aws.amazon.com