OpenSourceRaidGuild / tutorial-quest

As you delve deep into the Dungeons to take on the biggest baddest bosses, DON'T GO ALONE!! Take THE Open Source Raid Guild with you!
tutorial-quest.vercel.app
GNU Affero General Public License v3.0
37 stars 5 forks source link

docs: add all-contributors config and updated readme #3

Closed mpeyper closed 3 years ago

mpeyper commented 3 years ago

Adding initial all-contributors config for consideration. As discussed with @nobrayner, I've added a custom contribution type call raider that can be used to highlight any participants of current or previous raids.

This setup is compatible with the all-contributors bot if we want to set that up too, but it will only work for comments from within this repo. I think it's worthwhile still having so adding non-raid contributions a bit easier.

We were also discussing the idea of having out own automation to update the contributors list with raiders from commits/PRs to the raid repos. That would be as possible by having the automation run the contributors:add script with their username and the raider type, e.g. npm run contributors:add -- mpeyper raider, then commit the changes.

You can see the pretty version of the README here, but note that the badge won't work until the config is in the master branch.

Also, the contributions added in this PR are my best guess what they should be based on the react-hooks-testing-library and hospital-run raid, the website repo, this repo and discord. I tried to match the github users to the regular crowd in discord, but I may have missed some people. Please feel free to update this branch with new or changed contributions or let me know what they should be and I can update it. I know @JacobMGEvans's tweet said 25+ contributors on the hospital-run raid, but I struggled to find them all in the PRs and issues or the raid repo (there was lots to look through so I might have just missed them though).