Minimal Version about all-contributors

We wanted to do something like:

This is from Open Collective, based on the GitHub contributions graph only.

Unfortunately, this is not what we want as we also want to list contributors who spend time to help investigating issues, give feedback and such (which GitHub doesn't account for).

What we managed to do for now:

I guess we would need to be able to get rid of the table and maybe use a microservice to return circular avatars (as we can't use border-radius), or generate a tiled image.

Via getferdi/sponsors-only#1478

Quick update on the latest attempt here.
I edited all-contributors-cli locally to change generateContributorsList.

Via https://github.com/getferdi/ferdi/pull/266#issuecomment-617470631.

[matbrgz]

Just a ideia

https://getbootstrap.com/docs/4.2/about/team/

[matbrgz]

Awesome reference https://github.com/ipfs/contributors-hex-grid#interplanetary-contributors-webpage

[jvican]

I'd prefer a version that follows up on the minimal idea suggestion in the first comment, where the table only contains images and names. I currently do this manually in my project https://github.com/scalacenter/bloop but it's a little bit frustrating that the bot doesn't work if it doesn't recognise any contribution. I'd love if the bot could just append a contributor with no specific icon.

[jvican]

I see what you're trying to do and I'm wondering why you want to omit the contribution icons.

I want something that automates the addition of new people to the contributor list but I don't want to acknowledge (or think about) what kind of contributions they do. The contributors in my projects work on too many different things and the table goes rapidly out-of-date, so I just want their nice avatar in my README to credit them for any work instead of some specific domain work.

If someone is interested in who has which rights, they usually ask in Gitter (though it's uncommon, people just ask for reviews, they don't ask who's in charge of what).

[jdalrymple]

To get the circuluar icons, one could use this template:

"contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"https://images.weserv.nl/?url=<%= contributor.avatar_url %>&h=<%= options.imageSize %>&w=<%= options.imageSize %>&fit=cover&mask=circle&maxage=7d\" alt=\"<%= contributor.name %>\"/>",

All we need now is a configurable way to specify the wrapper element (basically to change from 'table' to 'p')

This results in this output:

[Berkmann18]

I want something that automates the addition of new people to the contributor list but I don't want to acknowledge (or think about) what kind of contributions they do. The contributors in my projects work on too many different things and the table goes rapidly out-of-date, so I just want their nice avatar in my README to credit them for any work instead of some specific domain work.

That makes sense, in that case (for now) using the maintenance category would be the way to go (at least until someone gets a minimal version working and released).

[kentcdodds]

I'd be fine with that. Feel free to PR to the spec to add a note about a minimal version being acceptable.

[Berkmann18]

@MatheusRV Have you started working on that?

[matbrgz]

@MatheusRV Have you started working on that?

Not yet.

[matbrgz]

twbs/bootstrap#27567 (comment)

[Berkmann18]

That looks good to although I believe it wouldn't be similar enough to the current AC table style/format with less info (e.g. no contribution emojis).

[matbrgz]

That looks good to although I believe it wouldn't be similar enough to the current AC table style/format with less info (e.g. no contribution emojis).

I think where is follow the emoji, we could improve this. I think in a 2 colum view for larger projects

[Berkmann18]

@MatheusRV The column view, that's already configurable; where the "contributorsPerLine" property in .all-contributorsrc could be set to 2.

I think it's definitely a good idea to have a place where visitors can 1-click to follow someone (which could be placed where contribution emojis are?)

[mrchief]

A minimal version would be wonderful!

In the meantime, switching to a markdown table would be helpful in reducing the readme size.

[Berkmann18]

@jvican

the bot doesn't work if it doesn't recognise any contribution. I'd love if the bot could just append a contributor with no specific icon

You can use the maintenance category (i.e. @all-... please add x for maintenance) and that should work fine, then you'll just need to remove the icons.

[jvican]

then you'll just need to remove the icons.

Do you mean I'll need to remove the icons manually from the PR created by the bot? What I want is the bot to add someone in the contributor list while not adding any icon at all. Otherwise, it defeats the purpose and it's just better to add that person manually.

[Berkmann18]

@mrchief

In the meantime, switching to a markdown table would be helpful in reducing the readme size.

True, and we may re-introduce it alongside the HTML option (cf. all-contributors/cli#173).

@jvican

Do you mean I'll need to remove the icons manually from the PR created by the bot? What I want is the bot to add someone in the contributor list while not adding any icon at all. Otherwise, it defeats the purpose and it's just better to add that person manually.

At the moment, yes as both the CLI and the bot requires at least one contribution type to be specified (at least until there's a minimal version implemented).

I see what you're trying to do and I'm wondering why you want to omit the contribution icons.

[maphew]

I like the look of the above bootstrap example best. It has room for contribution type emojis for those who track that. Also +1 for markdown table as option instead of html.

[jdalrymple]

Just waiting for the merge 🙌

[all-contributors-release-bot]

🎉 This issue has been resolved in version 2.17.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀