Re: An improved README experience for PostgreSQL

From: Nathan Bossart <nathandbossart(at)gmail(dot)com>
To: 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-04-17 02:36:09
Message-ID: 20240417023609.GA3228660@nathanxps13
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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.

[0] https://github.com/nathan-bossart/postgres/tree/special-files
[1] https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
[2] https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project
[3] https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

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

Attachment Content-Type Size
v1-0001-Add-code-of-conduct-contributing-and-security-fil.patch text/x-diff 1.2 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Andrei Lepikhov 2024-04-17 03:11:59 Re: POC: GROUP BY optimization
Previous Message David Rowley 2024-04-17 01:34:48 Re: Why is parula failing?