CONTRIBUTING.md

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

The JavaScript files in the wp.org repository are generated from CoffeeScript files in this github repository.

Initial Setup

• First, make a fork of this repo and clone it:

git clone --recurse-submodules [email protected]:{YOUR GITHUB USERNAME}/wp-front-end-editor.git front-end-editor

• Install node.js and npm.

• Install CoffeeScript globally, which will also install the cake utility:

npm install -g coffee-script

• Install local dependencies:

cd front-end-editor
npm install

• Add define('FEE_DEBUG', true); to your wp-config.php file.

Hacking

While working on CoffeeScript files (.coffee), you can set up automatic recompilation, like so:

cake watch

If that doesn't work well, there's an alternative, which requires the Jitter module:

npm install -g jitter
cake watch:j

If you're working on the Aloha plugins, you will have to call:

cake build:aloha

Building

This is necessary only for deploying to wordpress.org.

cake build