-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
feat: generate contributors PNG for README #8466
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
feat: generate contributors PNG for README #8466
Conversation
ksen0
left a comment
There was a problem hiding this 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 |
There was a problem hiding this comment.
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! | ||
|
|
||
|  |
There was a problem hiding this comment.
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
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
contributors.pngat build time from.all-contributorsrc.all-contributorsrc)Why PNG
I explored both SVG and PNG approaches:
Notes
Happy to iterate if there’s any preference.