Thank you for your interest in contributing! You're encouraged to submit pull requests, propose features and discuss issues. When in doubt, ask a question in the form of an issue.
Fork the project on Github and check out your copy.
git clone https://github.com/contributor/actionlogic.git
cd actionlogic
git remote add upstream https://github.com/rewinfrey/actionlogic.git
Make sure your fork is up-to-date and create a feature branch for your feature or bug fix.
git checkout master
git pull upstream master
git checkout -b my-feature-branch
Ensure that you can build the project and run tests.
bundle
bundle exec rspec spec
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to specs.
Pull requests with specs that highlight or reproduce a problem, even without a fix, are very much appreciated and welcomed!
Implement your feature or bug fix.
Make sure that bundle exec rspec spec completes without errors.
Document any external behavior in the README.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why.
git add ...
git commit
git push origin my-feature-branch
Go to https://github.com/contributor/ActionLogic and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
Go back to your pull request after a few minutes and see whether the Travis-CI builds are all passing. Everything should look green, otherwise fix issues and add your fix as new commits (no need to rebase or squash commits).
Any and all contributions are very appreciated!