Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1011 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1011 Bytes
Raw

Contributing

Please note that the following requirements are only required if you wish to contribute to the module and develop locally. If you wish to only use the module, please refer to the installation section.

Requirements

  • Node
  • NPM
  • GNU make
  • GNU sed
  • PHP >= 5.6
  • Composer
  • Git
  • Curl

Setting up your environment

Please ensure you have cloned the repository and have the required tools installed. You can then use make tools to install the composer and node dependencies. Alternatively, you can run composer install and npm install individually.

Building the CSS/JS assets

To build the CSS and JS assets, please run make build-assets

Running tests

Before running the tests please ensure you've

We have three different types of tests;

  • JavaScript Syntax Check npm run-script check-syntax
  • PHP Syntax/Sniffer vendor/bin/phpcs
  • PHP Unit Tests vendor/bin/phpunit

To run all three at once, you can run make test.