Add a CONTRIBUTING.md file
wuworkshop opened this issue · comments
After looking at some other repos, might be good to have a CONTRIBUTING.md file detailing how to contribute to the repo.
Examples:
https://github.com/railsbridge/docs/blob/master/CONTRIBUTING.md
https://github.com/yyx990803/vue/blob/master/CONTRIBUTING.md
++++
Sorry I didn't respond to your e-mail re: contributing hangout yet; I'm thinking next weekend too but wasn't sure when I'd be free. I'll plan to work on contributing.md then in real time!
No worries. I'm thinking of doing the install, forking, etc. in real time with all the other participants in the installfest hangout. Any caveats, errors, hiccups, etc. can be noted in the contributing.md with solutions.
Do you think the installfest should take place on a separate day as the pullrequest-fest? Or should it be 2 hours for the installfest -> immediately followed by a 1/2 hour where I screenshare an overview of how the repo works, and the largest issues that are open for people to contribute to?
hmm.. I just realized I wouldn't be able to do the Homebrew/Git/Github part in real time since I already have those things set up on my laptop (unless I decide to create a new user to follow along with everyone, or maybe set up a virtual machine). I'm not quite sure how long this installfest will take since this is the first time we're trying this virtual installfest experiment. I just posted the installfest hangout to gauge how much of an interest there is - http://hangouts.codebuddies.org/posts/9gKuN7btsY9mPToK7
I'm probably going to be lazy and borrow heavily from these sites for installation instructions:
https://help.github.com/articles/fork-a-repo/