Skip to content
This repository was archived by the owner on Oct 16, 2024. It is now read-only.

For Developers

Jump to bottom
Jen Baumann edited this page Apr 26, 2023 · 2 revisions

Development set up process

  1. Install Node.js, which also gives you the Node Package Manager (npm).
  2. Clone this repo into your wp-content/plugins/ directory.
  3. On the command line in the plugin directory, run npm install.
  4. Once installation is complete, run npm run dev to watch JS and CSS files for changes and build them using webpack.

Linting code

Scripts are provided to help with code linting. You can use these commands:

  • npm run lint:css to generate a report of style violations for CSS/SCSS.
  • npm run lint:css:fix to fix any style violations that can be corrected automatically.
  • npm run lint:js to generate a report of style violations for script files.
  • npm run lint:js:fix to fix any script violations that can be corrected automatically.
  • npm run lint:php to generate a report of style violations for script files.
  • npm run lint:php:fix to fix any php violations that can be corrected automatically.
  • npm run zip to create a pattern-manager.zip file.

Contributor License Agreement (CLA)

All external contributors to WP Engine products must have a signed Contributor License Agreement (CLA) in place before the contribution may be accepted into any WP Engine codebase.

  1. Submit your name and email
  2. 📝 Sign the CLA emailed to you
  3. 📥 Receive copy of signed CLA

❤️ Thank you for helping us fulfill our legal obligations in order to continue empowering builders through WordPress.

See the package.json file for more commands.

Clone this wiki locally