Re: An improved README experience for PostgreSQL - Mailing list pgsql-hackers

From Peter Eisentraut
Subject Re: An improved README experience for PostgreSQL
Date
Msg-id a20ac041-fe13-4fe3-a069-7c1ee1695229@eisentraut.org
Whole thread Raw
In response to Re: An improved README experience for PostgreSQL  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
List 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.




pgsql-hackers by date:

Previous
From: Jelte Fennema-Nio
Date:
Subject: Re: JIT compilation per plan node
Next
From: Peter Eisentraut
Date:
Subject: Re: An improved README experience for PostgreSQL