Contributing

Coding standards

All PHP, JavaScript, CSS and HTML code must follow WordPress Coding Standards.

Requirements

It's out of scope for us to tell you exactly how to set up your local development environment, but here are some minimum requirements:

PHP 5.36 or greater A web server like Apache or Nginx MySQL 5.0 or greater WordPress 4.0 or greater

Our ideal recommendations for maximum performance are:

PHP 7 Nginx MySQL 5.6 or greater WordPress 4.7

We use Vagrant ourselves and VVV is an open source option that is used by many in the WordPress community.

Unit tests

All pull requests must have accompanying unit tests if they do not already exist. Any new features will not be considered for merging unless they have unit tests. All tests should be added in the tests directory, which follows the same directory structure as the main plugin.

You'll need PHPUnit v4.5 or greater to run tests and Composer to complete the installation. Initially, you'll need to set up the test environment, you can do so by running this command from the main plugin directory:

bin/install-wp-tests.sh <db-name> <db-user> <db-pass> [db-host] [wp-version]

To install dependencies that are required by the unit tests, simply run this command from the main plugin directory:

composer install

After completing the above steps, to run tests, execute the command phpunit from the main plugin diew versrectory.

Release schedule

We try to release new versions of the plugin regularly. Any issues scheduled for resolution in a specific plugin version are noted using milestones. If you make a contribution, it will go live with the next version of the plugin once approved.