woocommerce-woocommerce-code-review

WooCommerce Monorepo

Welcome to the WooCommerce monorepo on GitHub. Here you can find all of the plugins, packages, and tools used in the development of the core WooCommerce plugin as well as WooCommerce extensions. You can browse the source, look at open issues, contribute code, and keep track of ongoing development.

We recommend all developers follow the WooCommerce development blog to stay up to date with everything happening in the project. You can also follow @DevelopWoo on X (formerly Twitter) for the latest development updates.

Getting Started

To get up and running within the WooCommerce Monorepo, you will need to make sure that you have installed all of the prerequisites.

Prerequisites

• Node.js: Required to run PNPM and the monorepo's build and test scripts. You do not need to match a specific Node version by hand. PNPM reads the version pinned in pnpm-workspace.yaml (useNodeVersion, mirrored in .nvmrc) and automatically installs and uses it for every script it runs. A Node version manager such as NVM is optional, but still handy for installing Node itself.
• PNPM: Our repository utilizes PNPM to manage project dependencies and run various scripts involved in building and testing projects.
• PHP 7.4+: WooCommerce Core currently requires PHP version 7.4 or higher. It is also needed to run Composer and various project build scripts. See troubleshooting for troubleshooting problems installing PHP.
• Composer: We use Composer to manage all of the dependencies for PHP packages and plugins.

Note: A POSIX-compliant operating system (e.g., Linux, macOS) is assumed. If you're working on a Windows machine, the recommended approach is to use WSL (available since Windows 10).

Once you've installed all prerequisites, the following will prepare all of the build outputs necessary for development:

# Install the PHP and Composer dependencies for all of the plugins, packages, and tools.
# PNPM automatically uses the pinned Node version for every script it runs.
pnpm install --frozen-lockfile
# Build all of the plugins, packages, and tools in the monorepo
pnpm build

Repository Structure

Each plugin, package, and tool has its own package.json file containing project-specific dependencies and scripts. Most projects also contain a README.md file with any project-specific setup instructions and documentation.

• Plugins: Our repository contains plugins that relate to or otherwise aid in the development of WooCommerce.
  • WooCommerce Core: The core WooCommerce plugin is available in the plugins directory.
• Packages: Contained within the packages directory are all of the PHP and JavaScript provided for the community. Some of these are internal dependencies and are marked with an internal- prefix.
• Tools: We also have a growing number of tools within our repository. Many of these are intended to be utilities and scripts for use in the monorepo, but, this directory may also contain external tools.

If you'd like to learn more about how our monorepo works, please check out this guide here.

Reporting Security Issues

To disclose a security issue to our team, please submit a report via HackerOne here.

Support

This repository is not suitable for support. Please don't use our issue tracker for support requests, but for core WooCommerce issues only. Support can take place through the appropriate channels:

• If you have a problem, you may want to start with the self help guide.
• The WooCommerce.com premium support portal for customers who have purchased themes or extensions.
• Our community forum on wp.org which is available for all WooCommerce users.
• The Official WooCommerce Facebook Group.
• For customizations, you may want to check our list of WooExperts or Codeable.

NOTE: Unfortunately, we are unable to honor support requests in issues on this repository; as a result, any requests submitted in this manner will be closed.

Community