I love pull requests. I'm trying to keep it as easy as possible to contribute changes. There are just a couple of guidelines to follow to help me stay on top of things.
Whether you're fixing a bug or adding a feature, feel free to talk to me first on twitter. We can make sure the change isn't already underway somewhere else.
- Make sure you have a GitHub account
- Open a New Issue on github for your change, assuming one does not already exist. If one already exists, join the conversation.
- Fork the repository on GitHub.
Clone the repo:
git clone https://github.com/<your-username>/invitation
CD into your clone and run bundler install:
cd invitation && bundle install
Make sure the tests pass:
rake
Make your change. Add tests for your change. Make sure the tests pass:
rake
I use rubocop to maintain ruby coding style. Install and run it like so:
gem install rubocop
rubocopOnce you resolve any issues rubocop finds, you're ready to go. Push your fork and submit a pull request.
The ball is now in my court. I'll try to comment on your pull request within a couple of business days (hopefully the same day).
Things you can do to increase the speed of acceptance:
- talk to me ahead of time
- write tests
- follow the ruby style guide
- write a good commit message
Thanks very much!