Skip to content

meta: add community health files for org README #10

Open

Description

@JacobCoffee

On the landing page of the organization we have an opportunity to bring attention to things like CoC, events, and other quick links - as well as a place to display sponsors.

Some examples from across the GitHub land:

github.com/microsoft image
github.com/django image
github.com/litestar-org image image
github.com/getsentry image

There are two distinct customization here: internal and public.

This means we could have an internal (anyone in the python organization) README with some nice-to-knows or events to keep track of (buildbot outage windows, reminders to enable 2FA, etc.) and a public one with the aforementioned links.

Some documentation about it:

Activity

  1. aijadugar commented on Oct 3, 2024

    @aijadugar

    ALL OK...#10

    I tried to make it super best from my side...

    Thanks, to make my 1st open-source contribution...

    image

  2. aijadugar commented on Oct 5, 2024

    @aijadugar

    @JacobCoffee are you reviewed that...

  3. JacobCoffee commented on Oct 8, 2024

    @JacobCoffee
    MemberAuthor

    I'm not the deciding person here :) But yes something along the lines of what you have. I was curious if we are able to incorporate sponsors here which would require PSF staff input and they are out for the month.

  4. self-assigned this
    on Jan 28, 2026
  5. nedbat commented on Oct 6, 2026

    @nedbat
    Member

    This idea came up at today's Docs community meeting. I would focus the page on people interested in contributing, since they are already at github.com. So I wouldn't include marketing copy, and I wouldn't include sponsors. Of the four examples, Django seems the right flavor.

    In today's discussion, this came up because someone new to contribution wasn't sure where to start. Coming to the organization page and searching for "doc" to find a repo goes to a (slightly) wrong place.

  6. nedbat commented on Oct 6, 2026

    @nedbat
    Member

    Here's another example of an org README that focuses on contributors: https://github.com/openedx/

    Image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions