Be sure to have Node.js installed first. You should be running a Node version matching the current active LTS release or newer for this plugin to work correctly. You can check your Node.js version by typing node -v in the Terminal prompt.
You should also have the latest release of npm installed, npm is a separate project from Node.js and is updated frequently. If you've just installed Node.js which includes a version of npm within the installation you most likely will need to also update your npm install. To update npm, type this into your terminal: npm install npm@latest -g
To test the plugin, or to contribute to it, you can clone this repository and build the plugin files using Node. How you do that depends on whether you're developing locally or uploading the plugin to a remote host.
Next, open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type npm run setup-theme-dev to get the dependencies all set up. Then you can type npm run dev in your terminal or command prompt to keep the theme building in the background as you work on it.
A good workflow for new contributors to follow is listed below:
- Fork the repository
- Clone forked repository
- Create new branch
- Make code changes
- Commit code changes within newly created branch
- Push branch to forked repository
- Submit Pull Request to
bigboxrepository
Ideally name your branches with prefixes and descriptions, like this: [type]/[change]. A good prefix would be:
add/= add a new featuretry/= experimental feature, "tentatively add"update/= update an existing featureissue/= solve an open issue