Skip to content

Add a contributor wall to the README's Community section - #139

Open
cu1ch3n wants to merge 1 commit into
mainfrom
docs/contributors-wall
Open

cu1ch3n wants to merge 1 commit into
mainfrom
docs/contributors-wall

Conversation

@cu1ch3n

@cu1ch3n cu1ch3n commented Nov 11, 2026

Copy link
Copy Markdown
Member

What and why

The author asked for a contributor wall in the README's Community section.

  • Under the three Community items, a fourth line, Thank you to everyone who has contributed., followed by the contributors' GitHub avatars and names, linking to the repository's contributors page.
  • scripts/build-readme-contributors.ts (run with node --import tsx scripts/build-readme-contributors.ts) collects everyone with a merged pull request or a commit on main, leaves out bots and the maintainer (who asked to be left out of contributor lists; one line to change), sorts by merged pull requests, then commits, and draws docs/assets/readme-contributors/desktop.svg (one row of up to 8) and compact.svg (3 per row, used under 600 px). Avatars are embedded, so GitHub shows them inside the image; text and ring colours follow light or dark appearance.
  • Only the images change when someone new contributes, so the README's text, and with it its translations, stays the same after this PR.
  • docs/assets/readme-icons/heart.svg matches the other Community icons.

Today's wall: chengluyu, CatIIIIIIII, jiangsy, RIvance, kilbertert, Ricardo-Ray.

Translations

English only for now, as with every README change: the other README languages are translated after the author approves the English wording, so i18n check fails on this PR until then.

How it was checked

  • Rendered the section with GitHub's Markdown API and GitHub's stylesheet: desktop light and dark, and an iPhone width (390 px) in light and dark.
  • git diff --check

Thank the people who have contributed with their GitHub avatars and names
under the Community section. scripts/build-readme-contributors.ts collects
everyone with a merged pull request or a commit on main, leaves out bots
and the maintainer, and draws one image per layout (desktop, phone) whose
colours follow the reader's light or dark appearance. Only the images
change when someone new contributes, so the README's text and its
translations stay as they are.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant