Acknowledgements/contributors list

[Angamanga]

We want it to look like the Mozilla example in The MOSS grant application...Link to follow

[rowasc]

https://www.mozilla.org/credits/faq/ is it this format?

[Angamanga]

@rowasc @Erioldoesdesign Maybe the Mozilla-example looks a bit... empty for us? We don't have as many contributors yet. This is another interesting way of crediting everyone doing contributions, not only developers: https://www.audacityteam.org/about/credits/

[rowasc]

I love that example https://www.audacityteam.org/about/credits/
I really like our contributors thing in GitHub but it doesn't recognize non-code , outside of GitHub contributors, like folks who add to transifex , so something in between would be nice.

[rowasc]

https://contributors.rubyonrails.org ok I think this might be my favorite example that I've found so far

[Erioldoesdesign]

🤔 hmmm rankings kind of make me feel a bit...uneasy? Like it's a competition...

The mozilla example I liked was this one that detailed out people more and made a big deal out of them :D
https://github.com/firefox-devtools/debugger/blob/master/docs/community-team.md

[rowasc]

ah sorry I didn't mean the rankings (which yea,it's not what I want, you're right) , I meant the format and the fact that you can track down what specific contribution someone made, and also the fact that there is a "manual add" feature (so not just commits) and also the fact that they show all contributors in the home page instead of just the ones that made large contributions

[rowasc]

oh wow I'm inn love with this one that you shared https://github.com/firefox-devtools/debugger/blob/master/docs/community-team.md let's do one like theirs !!!! (maybe smaller pictures but still, the general idea)

[Erioldoesdesign]

combine the ideas to make the ultimate contributor list! 💯

[rowasc]

Kept thinking about this one. The only thing that bothers me about the Mozilla example is the manual process, to be honest. They have ~359 contributors in the dev-tools debugger project (https://github.com/firefox-devtools/debugger/graphs/contributors), but that page only lists the core community team, which also explains why it has so much detail (vs the list I had found in mozilla.org where they seemed to have listed everyone in plain text)

I'm biased towards finding a way to mostly keep this simple to maintain without requiring people to code or edit a markdown to do so, that way everyone can both add contributors and be added as a contributor with minimal effort. It means people who are not devs can give credit, too.
With that in mind, I think we may be able to start with using the all contributors bot which is a pretty big improvement over our current setup that only counts devs.

The bot:
https://allcontributors.org/docs/en/emoji-key allows us to actually track contributions from ALL PEOPLE not just developers and not just people who commit code or docs (with this you can even give credit for bug reports or answering a question!!! )

What the bot does is that it lets you write @allcontributors please add Eriol to the contributors list for Design and Docs anywhere in issues/PRs/whatever and then it adds Eriol to the list with the link to their profile and the types of contributions they did.

It looks really nice too, but less full of detail than the Mozilla example. It doesn't rank by commits, which is good... it looks like it just sorts by when someone first contributed to the project, and if we ever want to change the order for some reason, the list can be manually edited to do so.

https://allcontributors.org/docs/assets/contributors-table-small.png

It generates the content in the README or another file.

https://github.com/all-contributors/all-contributors more examples from them and links to docs/who else is using it

Adding more detail in the bot - forking:

If we want to add more details for everyone, It would require extending that bot. That's probably doable if someone wants to take it up ...the code where they process the message seems to be here in case anyone is curious ( https://github.com/all-contributors/all-contributors-bot/blob/master/src/tasks/processIssueComment/OptionsConfig/index.js ) but it would mean hosting the bot ourselves until/unless we can get it approved to merge which involves modifying the all contributors spec.

@Angamanga @Erioldoesdesign would appreciate feedback.

[Erioldoesdesign]

Agreed that something that requires less manual upkeep is best for now (and probably for the future too!) 100% happy with this solution and the possibility of customizing the bot if there's something critical we need to add.

[rowasc]

If anyone is curious about what this looks like when used, I tried it in the PWA to get a sense of how it works in the wild.
Called the bot here

ushahidi/pwa-prototype-reporting#10

Bot added a PR (which I just clicked->clicked->merged in like 10seconds)

Bot added Nidhi as a contributor for docs and code in
Bot added Nidhi as a contributor for docs and code in https://github.com/ushahidi/pwa-prototype-reporting/README.md

Then I tried adding Anna too for her ideas on the PWA
ushahidi/pwa-prototype-reporting#20
And the bot did its thing 🎉

I know I'm overselling this but I just really like this bot lol

---

Note: right now the custom types appear to be buggy or I'm just not understanding how to set them up. I just followed up in an issue with them to see if it can get fixed or if they have pointers :) the default types are generally enough right now, but I'd really prefer to have mentoring be a type of contribution too rather than default to a generic type 😬 , and I'm sure we'll have things like user-testing participant for instance in the feature we may want to add so it'd be good.

[Angamanga]

I really like this idea! It seems good enough and I am not sure we want super-much detail either? I think simple and easy is more important than lots of detail! Is it possible to add people who are not in github? I'm thinking for example translators?

[Angamanga]

Also, is it possible to add it to gitbooks rather than a repo?

[rowasc]

I think we can make it happen in GitBooks since they are just .md files but I'm not totally sure, I'll try in a bit when I enable it for GitHub :)

Is it possible to add people who are not in github? I'm thinking for example translators?

Yes :D

@tuxpiper any concerns on this before I enable it? -sorry I realized I. didn't tag you yesterday 😬 -

[rowasc]

@Angamanga ah, I just realized it matched it with a github profile :( That kind of stinks for our usecase with translators and user testers ...
I'm going to try and find an alternative , and if not we will have to give the option to either join GitHub with their username or they can be added manually right before or right after the all-contributors list :( :( ugh now I really want to fork this bot lol