You want to contribute? Great! Thanks for being awesome! Volt is work of hundreds of contributors. You're encouraged to submit pull requests, propose features and discuss issues. When in doubt, ask a question in the Volt gitter.im chatroom.
If you want to contribute, but aren't sure what to work on, we keep our list of current todos in Trello at https://trello.com/b/QdCx9Tqb/volt Before starting, feel free to chat with me @ryanstout on gitter.
Fork the project on Github and check out your copy.
git clone https://github.com/contributor/volt.git
cd volt
git remote add upstream https://github.com/voltrb/volt.git
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
git checkout master
git pull upstream master
git checkout -b my-feature-branch
Ensure that PhantomJS is installed on your computer.
phantomjs --version
If not installed, you can install from the source or use Homebrew:
brew upgrade && brew install phantomjs
You need 2.0 for MutationObserver API support, so until this issue teampoltergeist/poltergeist#574 is resolved that poltergeist will support phantomjs 2.0, the test for attribute binding has to be in a real browser.
Ensure that you can build the project and run tests.
bundle install
bundle exec rake
By default rake doesn't run the integration tests. The integration tests use capybara to run the tests in a real browser, (read more here). You can run with integration tests in a browser with:
BROWSER=firefox bundle exec rake
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.
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
Implement your feature or bug fix.
Ruby style is enforced with RuboCop, run bundle exec rubocop and fix any style issues highlighted.
Make sure that bundle exec rake 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 "contributor@example.com"
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/volt and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
If you've been working on a change for a while, rebase with upstream/master.
git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f
Update the CHANGELOG with the pull request number. A typical entry looks as follows.
* [#123](https://github.com/voltrb/volt/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
Amend your previous commit and force push the changes.
git commit --amend
git push origin my-feature-branch -f
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
Please do know that we really appreciate and value your time and work. We love you, really.