Horton

Re: An improved README experience for PostgreSQL

Nathan Bossart <nathandbossart@gmail.com>

View thread
From: Nathan Bossart <nathandbossart@gmail.com>
To: Greg Sabino Mullane <htamfids@gmail.com>
Cc: Andrew Atkinson <andyatkinson@gmail.com>, Tom Lane <tgl@sss.pgh.pa.us>, pgsql-hackers@postgresql.org, samay@tembo.io
Date: 2024-02-28T17:10:48Z
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.

On Wed, Feb 28, 2024 at 09:56:57AM -0500, Greg Sabino Mullane wrote:
> +1 on the general idea. Maybe make that COPYRIGHT link go to an absolute
> URI, like all the other links, in case this file gets copied somewhere?
> Perhaps point it to https://www.postgresql.org/about/licence/

I suspect there will be quite a bit of discussion about what to add to the
README, which is great, but I think we should establish an order of
operations here.  We could either add suggested content to the README and
then create an identical Markdown version, or we could create a Markdown
version and add content to both afterwards.  The former has my vote since
it seems like it would require less churn.  In any case, I think it would
be useful to keep the Markdown effort separate from the content effort
somehow (e.g., separate threads).

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