Skip to content

Conversation

@skyash-dev
Copy link
Contributor

@skyash-dev skyash-dev commented Jan 28, 2026

Resolves #8237

What this does

This PR adds a generated contributors image to the README to improve visibility for project contributors without reintroducing a large table.

Implementation details

  • Generates a single static contributors.png at build time from .all-contributorsrc
  • Uses a GitHub Actions workflow that runs only when the contributors list changes (.all-contributorsrc)
  • The README embeds the generated PNG (single request, no runtime network access)

Why PNG

I explored both SVG and PNG approaches:

  • GitHub does not render SVGs that reference external images
  • Base64-embedded SVGs do work, but in practice resulted in a much larger artifact (~56 MB vs ~3 MB for PNG)
  • Given file size as a priority and the fact that this is a generated visual artifact, a single PNG felt like the more predictable trade-off

Notes

  • Avatars are resized to match the display size to keep the output reasonable
  • The workflow runs in CI only and has no impact on runtime performance

Happy to iterate if there’s any preference.

Copy link
Member

@ksen0 ksen0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much, excited to see this almost there! Couple minor things

- name: Install dependencies
run: npm install canvas node-fetch

- name: Run contributors-svg generator
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: not svg, also on lines 36 and 46, please double check. Also, were you able to test locally (eg nektos/act or in your own fork?


We recognize all types of contributions. This project follows the [all-contributors specification](https://github.com/all-contributors/all-contributors) and the [Emoji Key](https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md) ✨ for contribution types. Instructions to add yourself or add contribution emojis to your name are [here](https://github.com/processing/p5.js/issues/2309). You can also post an issue or comment on a pull request with the text: `@all-contributors please add @YOUR-USERNAME for THINGS` (where `THINGS` is a comma-separated list of entries from the [list of possible contribution types](https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md)) and our nice bot will add you to [CONTRIBUTORS.md](./CONTRIBUTORS.md) automatically!

![](contributors.png "contributors")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add descriptive label (<100 words) - best practices for alt text with md

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.

Contributors overview image for the README.md

2 participants