Re: An improved README experience for PostgreSQL

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>, Nathan Bossart <nathandbossart(at)gmail(dot)com>
Cc: Andrew Atkinson <andyatkinson(at)gmail(dot)com>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, "David E(dot) Wheeler" <david(at)justatheory(dot)com>, 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-14 07:55:49
Message-ID: a20ac041-fe13-4fe3-a069-7c1ee1695229@eisentraut.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 13.05.24 17:43, Alvaro Herrera wrote:
> On 2024-May-13, Nathan Bossart wrote:
>
>>> 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
>>
>> This was the intent of my patch. There might be a few others that we could
>> use, but I figured we could start with the low-hanging fruit that would
>> have the most impact on the GitHub experience.
>
> Can't we add these two lines per topic to the README.md?

The point of these special file names is that GitHub will produce
special links to them. If you look at Nathan's tree

https://github.com/nathan-bossart/postgres/tree/special-files

and scroll down to the README display, you will see links for "Code of
Conduct", "License", and "Security" across the top.

Whether it's worth having these files just to produce these links is the
debate.

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2024-05-14 08:05:01 Re: An improved README experience for PostgreSQL
Previous Message Jelte Fennema-Nio 2024-05-14 07:55:48 Re: JIT compilation per plan node