CONTRIBUTING.md

This guide is meant for developers wanting to work on the plugin code.

Setup

Make a fork and clone it:

git clone --recurse-submodules [email protected]:{YOUR GITHUB USERNAME}/wp-posts-to-posts.git posts-to-posts

You can now work on the PHP and CSS files.

JavaScript

Don't modify admin/box.js directly. Instead:

• Install node.js.

• Install CoffeeScript:

npm install -g coffee-script

and edit the admin/box.coffee file. To compile it, run:

coffee -c admin

Testing

The plugin comes with a few unit tests.

1. Install PHPUnit.
2. Create tests/wp-tests-config.php file. (sample)
3. Install the scbFramework in the mu-plugins dir.
4. Run ./bin/test