Contributing

First, thanks for helping out! In order to ensure this plugin remains of quality, there are some guidelines/rules I've put together to keep this plugin in tip-top.

1. Run the precommit.sh script before submitting a pull request. This will run all unit/integration tests locally as well as generating new documentation. I've only tested this on Mac so far so feel free to submit tweaks to get it to work on your platform. If you cannot get it to run, submit anyway and I will pull down and run locally.
2. Any pull requests that fail on TravisCi will not be accepted.
3. Any pull requests that are created to address a bug, must be accompanied by a test case that can reproduce the test. Without a test, the pull request will not be accepted.
4. If you are adventurous enough, there is a tests/selenium.sh script that will light up a Vagrant VM locally with a wordpress installation and run a headless browser to walk through the application to make sure the UI is good. Kudos if you verify this before submitting a pull. Eventually this will be automated in TravisCI as well.
5. All code you submit was created by yourself or is accompanied with a license that is compatible with that of the project.
6. Follow all documentation in the wiki (such as naming conventions) for things like filter names, etc.