Convert WMATA script to npm package?

civictechdc / muttbot

Code for DC's Hubot instance

4 stars 1 forks source link

Convert WMATA script to npm package? #3

Open dnrce opened 7 years ago

dnrce commented 7 years ago

Hi @stvnrlly,

Would you consider converting your great WMATA script into its own npm package so other DC-area Hubot operators can benefit (and contribute)?

Thanks!

stvnrlly commented 7 years ago

I'd definitely be interested in that. Is there a Hubot guide for structuring the package?

dnrce commented 7 years ago

There is -- in fact there's a tool, too: https://github.com/github/hubot/blob/master/docs/scripting.md#creating-a-script-package

dnrce commented 7 years ago

I should note that I'm totally willing to jump in and help here, as well. It's your code so I don't want to step on any toes, but you've already done the work to create this so I also don't want to demand further of you. Happy to take care of the packaging bit if you'd like.

stvnrlly commented 7 years ago

Thanks for that offer, @dnrce. I'm interested in trying this out, but if I haven't done it in a week or two I'll hand it back over.

dnrce commented 7 years ago

👍

No rush whatsoever. Thanks!

dnrce commented 7 years ago

I went ahead and created https://github.com/dnrce/hubot-wmata for your review, to be transferred to the @codefordc org or your personal account once it's polished up. I used git filter-branch to extract the existing commits for the script from the muttbot repo. Things to review:

License (in package.json)
Author information
Squash the fixup commit or make it a full-fledged commit?

stvnrlly commented 7 years ago

Oh, how wonderful, thank you! I'm fine with this as you've set it up.

Two small additional things:

[ ] add the CC0 text as LICENSE.md in the root of the repo
[ ] add yourself as a contributor in package.json, if you'd like

dnrce commented 7 years ago

Thanks, @stvnrlly! Updated. I chose to squash the fixup commit (dnrce/hubot-wmata@3fa9ea559ff7bdea503aafd53e9583877e8d18a9) into the commit it amended, but can revert that if you'd prefer to keep it separate.

Transferring to an org requires the transferrer to be an org admin, so it'll probably be easiest if you just pull this down and then push to a new repo.