vue-wp/plugins/posts-to-posts/CONTRIBUTING.md

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

Setup

Step 1: Make a fork and clone it:

git clone git@github.com:{YOUR GITHUB USERNAME}/wp-posts-to-posts.git posts-to-posts

Step 2: Install the dependencies via Composer:

php composer.phar install

You can now work on the PHP and CSS files. Please follow the WordPress Coding Standards.

Step 3: Open a pull request.

Note: This repository only contains the admin UI; the core functionality is in lib-posts-to-posts.

Unit Tests

If you want to add a new feature, please consider adding a new test for it as well.

The following instructions assume a UNIX-like environment (OS X, Linux, etc.).

Step 1: Install and configure the official WordPress testing suite:

./bin/install-wp-tests

Note that all data in the test DB will be deleted once you run the tests.

Step 2: Run the tests:

phpunit