search

FormidableLabs / react-music

Make beats with React!
http://reactmusic.surge.sh
MIT License
2.72k stars 197 forks source link

#32 Added basic contribution guidelines #33

Closed alavkx closed 8 years ago

alavkx commented 8 years ago

Getting started with making a contribution to the project. A how-to with a few bits of advice on making a good PR. Tried to make the description friendly to new oss contributors...considering I'm part of that group.

Thanks and credit goes to @TalAter. I referenced his post here: https://github.com/TalAter/Progressive-UI-KITT/issues/1 to make the guidelines.

davidnaas commented 8 years ago

Good initiative! It would also be nice to have a part more focused on the stylistic rather than technical parts of commits and pr flow to keep a consistent history!

alavkx commented 8 years ago

I'll do that next! Let me know of anything specific you want included. Otherwise I'll just reference other repos contrib files and cross my fingers.

davidnaas commented 8 years ago

I think that's for @kenwheeler to decide. I just want something to lean against :)

TalAter commented 8 years ago

Thanks for the mention @alavkx 👍 You might also want to have a look at the contribution guide itself: https://github.com/TalAter/annyang/blob/master/CONTRIBUTING.md

kenwheeler commented 8 years ago

Awesome! Re: style, I'll get lint/test CI in place and that should manage that.

alavkx commented 8 years ago

That would be a good place to start wouldn't it.. Ha. Thanks @talater