Horton

Re: An improved README experience for PostgreSQL

Peter Eisentraut <peter@eisentraut.org>

View thread
From: Peter Eisentraut <peter@eisentraut.org>
To: Nathan Bossart <nathandbossart@gmail.com>, Andrew Atkinson <andyatkinson@gmail.com>
Cc: Tom Lane <tgl@sss.pgh.pa.us>, "David E. Wheeler" <david@justatheory.com>, Alvaro Herrera <alvherre@alvh.no-ip.org>, Joe Conway <mail@joeconway.com>, Daniel Gustafsson <daniel@yesql.se>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, Samay Sharma <samay@tembo.io>
Date: 2024-05-12T15:17:42Z
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 17.04.24 04:36, Nathan Bossart wrote:
> On Wed, Feb 28, 2024 at 02:21:49PM -0600, Nathan Bossart wrote:
>> I see many projects have files like SECURITY.md, CODE_OF_CONDUCT.md, and
>> CONTRIBUTING.md, and I think it would be relatively easy to add content to
>> each of those for PostgreSQL, even if they just link elsewhere.
> Here's a first attempt at this.  You can see some of the effects of these
> files at [0].  More information about these files is available at [1] [2]
> [3].
> 
> I figured we'd want to keep these pretty bare-bones to avoid duplicating
> information that's already available at postgresql.org, but perhaps it's
> worth filling them out a bit more.  Anyway, I just wanted to gauge interest
> in this stuff.

I don't know, I find these files kind of "yelling".  It's fine to have a 
couple, but now it's getting a bit much, and there are more that could 
be added.

If we want to enhance the GitHub experience, we can also add these files 
to the organization instead: 
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file