Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1.59 KB
Raw

Contributing to the development of the WP101 Plugin

The WP101 Plugin is the client-facing end of the WP101 Plugin SaaS and is used to present video training right within WordPress.

Installing dependencies

After cloning the repository, development dependencies are installed via npm and Composer:

# Install JavaScript dependencies
$ npm install

# Install PHP dependencies
$ composer install

Coding standards

This plugin uses the WordPress coding standards, which are enforced via PHP_CodeSniffer.

Compiling assets

Front-end assets (CSS and JavaScript) are light in the plugin, but are compiled and concatenated via Grunt:

# Compile assets.
$ grunt

Running tests

Tests for the plugin are written using the WordPress core test suite, and are run automatically as part of the plugin's Continuous Integration (CI) pipeline.

When contributing code, please include appropriate tests!

Building a release

When the plugin is ready for release, we use Grunt to build our release:

$ grunt build

This will compile all assets, then copy the files necessary for inclusion into a dist/ directory. This directory can be copied directly into the trunk directory of the WordPress plugin's Subversion repo:

cp -r dist/* /path/to/svn/wp101/trunk