CONTRIBUTING.md

Contributing to the Coldbox theme

Thanks for contributing to the Coldbox theme! I always welcome any contributions for the project. There are only a few things to know before contributing.

Coding Standards

This project follows the WordPress Coding Standards for PHP codes.

For JavaScript files, I use Standard Style and Prettier.

I don't currently use any standards for the SCSS files.

Running the linters

Please make sure that no errors are reported by the linters before submitting a PR.

PHP

$ composer lint

To auto-fix your problems:

$ composer fix

JavaScript

$ yarn lint

To auto-fix your problems:

$ yarn fix

Transpile JS/SCSS files

I use Webpack for transpiling JavaScript and SCSS files.

Run the following command to watch your changes:

$ yarn watch

Bottom Line

These are all you need to know. If you need help, as always please let me know so that I can help.