We happily review/accept third-party Pull Requests. To help get your patches adopted into our plugins, there's a few bits of info that are worth knowing.
We have a set of coding standards
that we follow and encourage others to follow as well. When you submit
Pull Requests, you'll probably notice a friendly bot - tr1b0t
- that
comments on your PR and suggests changes. Be gentle with him, he's only
trying to help. He also has a pretty good idea about what we'd like to
see in terms of code formatting, so don't ignore him.
We rely on a few submodules, you'll need those to continue.
git submodule update --init --recursive
Note: you'll need to do this for the common directory and the root directory.
cd common
composer install
cd ..
composer install
Note: you'll need to do this for the common directory and the root directory.
cd common
nvm use
npm ci
npm run build
cd ..
nvm use
npm ci
npm run build
Our npm run build
command is simply an alias to running both our Gulp and webpack builds. You can run them individually like so:
npm run build:gulp
npm run build:webpack
We also provide gulp watch
tasks, so feel free to leverage those while tinkering with CSS or JS to run the build process automatically when you change files.