Add a build script to add contributors to the README

[yeskunall]

So I quickly put this together, because I want feedback before I make any drastic additions. Currently, it just adds a raw output (formatted to Markdown) at the end of the README, which works fine if it's the first time. But the next time it's run, it just appends the result to the end of the file, which isn't what we're looking for.

So my question is this: since @jakedex wants to add the contributors to the end of the README for now (as discussed in #92, should we just manually add them from time to time? When time comes, we can use something like all-contributors-cli to generate a CONTRIBUTORS.md for us and it will (hopefully) handle the issues I've pointed out here.

... or should I add some logic to the current script to check for existing users, and only add those that weren't previously in the list?

Thoughts?

• Closes Create build script to add contributors to the README #79

[jakedex]

Thanks for getting the ball rolling on this. It looks like all-contributors-cli will handle injecting updates to the README.md, let's just add a .all-contributorsrc, a npm script for contrib:add, and contrib:build to precommit?

[yeskunall]

Whoopsie, should have read their README a bit more closely. 🙊 if that's the case, I'll look into it right away!

[yeskunall]

Hey @jakedex 👋

I just wanna make sure we're on the same page: you want a contrib:add that basically calls all-contributors add, which would mean a contributor is added using the CLI? How would that work?

... and I'm guessing contrib:build was to be followed by the previous command that ran all-contributors generate?

In any case, look at the changes I've introduced. It works just fine, except that there's no way to add emoji keys to the contributors as I'm just pulling in the contributors, not the type of contribution (which I don't think is possible)

[mfix22]

@yeskunall thanks for this! Now that we are going with all-contributors, you can just use all-contributors add and all-contributors generate. See these lines for reference.

And actually, the emojis are generated from the key words in the contributions array. You can see an example here: https://github.com/kentcdodds/all-contributors/blob/master/.all-contributorsrc#L15-L19

[jakedex]

Apologies for the vague response, @yeskunall. I was trying to say that we should just do this all manually with the npm scripts and scrap contributors.js for the time being. Again, sorry for the confusion!

[yeskunall]

All right, understood. I'll scrap the script and manually add the contributors and update the README. Gotta leave for work, but this should be merged by today evening.

❤️

[yeskunall]

All right, so the npm scripts are done and good to go. Final question: @mfix22, who's going to add the emojis keys to the contributors' block? 😛

I'm willing to do it, but the CLI asks questions of the likes:

... and I'm not sure if I should be the one deciding that. 🚶

(Once I get a response, I'll also fix the npm precommit script. Noticed it after I pushed 🙈

[mfix22]

I can handle that @yeskunall (: mind if i run the CLI and push to your branch?

[yeskunall]

Be my guest! ❤️

--

Kunall Banerjee

[yeskunall]

LGTM. We ready to merge?

[mfix22]

Thanks @yeskunall for all your work and comments!