Re: An improved README experience for PostgreSQL

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Nathan Bossart <nathandbossart(at)gmail(dot)com>, Andrew Atkinson <andyatkinson(at)gmail(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, "David E(dot) Wheeler" <david(at)justatheory(dot)com>, Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>, Joe Conway <mail(at)joeconway(dot)com>, Daniel Gustafsson <daniel(at)yesql(dot)se>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>, Samay Sharma <samay(at)tembo(dot)io>
Subject: Re: An improved README experience for PostgreSQL
Date: 2024-05-12 15:17:42
Message-ID: 065e5cfb-5802-4e5e-b74d-b21a61776c95@eisentraut.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Paul Jungwirth 2024-05-12 15:51:11 Re: SQL:2011 application time
Previous Message Alvaro Herrera 2024-05-12 14:56:09 Re: cataloguing NOT NULL constraints