Re: An improved README experience for PostgreSQL

Roberto Mello <roberto.mello@gmail.com>

From: Roberto Mello <roberto.mello@gmail.com>

To: "David E. Wheeler" <david@justatheory.com>

Cc: Alvaro Herrera <alvherre@alvh.no-ip.org>, Joe Conway <mail@joeconway.com>, Daniel Gustafsson <daniel@yesql.se>, Nathan Bossart <nathandbossart@gmail.com>, Tom Lane <tgl@sss.pgh.pa.us>, Andrew Atkinson <andyatkinson@gmail.com>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, Samay Sharma <samay@tembo.io>

Date: 2024-03-21T13:52:38Z

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 Wed, Feb 28, 2024 at 11:55 AM David E. Wheeler <david@justatheory.com>
wrote:

>
> IME the keys to decent-looking Markdown are:
>
> 1. Wrapping lines to a legible width (76-80 chars)
> 2. Link references rather than inline links


+1 on Markdown including David's suggestions above. Agree that without
proper guidelines,
md files can become messy looking.

Roberto