Horton

Re: An improved README experience for PostgreSQL

Peter Eisentraut <peter@eisentraut.org>

View thread
From: Peter Eisentraut <peter@eisentraut.org>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>, Nathan Bossart <nathandbossart@gmail.com>
Cc: Andrew Atkinson <andyatkinson@gmail.com>, Tom Lane <tgl@sss.pgh.pa.us>, "David E. Wheeler" <david@justatheory.com>, Joe Conway <mail@joeconway.com>, Daniel Gustafsson <daniel@yesql.se>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, Samay Sharma <samay@tembo.io>
Date: 2024-05-14T07:55:49Z
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 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.