65 lines
4.8 KiB
Markdown
65 lines
4.8 KiB
Markdown
# 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 tracking of ongoing development.
|
|
|
|
We recommend all developers to follow the [WooCommerce development blog](https://woocommerce.wordpress.com/) to stay up to date about everything happening in the project. You can also [follow @DevelopWC](https://twitter.com/DevelopWC) on 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
|
|
|
|
- [NVM](https://github.com/nvm-sh/nvm#installing-and-updating): While you can always install Node through other means, we recommend using NVM to ensure you're aligned with the version used by our development teams. Our repository contains [an `.nvmrc` file](.nvmrc) which helps ensure you are using the correct version of Node.
|
|
- [PNPM](https://pnpm.io/installation): Our repository utilizes PNPM to manage project dependencies and run various scripts involved in building and testing projects.
|
|
- [PHP 7.4+](https://www.php.net/manual/en/install.php): WooCommerce Core currently features a minimum PHP version of 7.4. It is also needed to run Composer and various project build scripts. See [troubleshooting](DEVELOPMENT.md#troubleshooting) for troubleshooting problems installing PHP.
|
|
- [Composer](https://getcomposer.org/doc/00-intro.md): We use Composer to manage all of the dependencies for PHP packages and plugins.
|
|
|
|
Once you've installed all of the prerequisites, you can run the following commands to get everything working.
|
|
|
|
```bash
|
|
# Ensure that you're using the correct version of Node
|
|
nvm use
|
|
# Install the PHP and Composer dependencies for all of the plugins, packages, and tools
|
|
pnpm install
|
|
# Build all of the plugins, packages, and tools in the monorepo
|
|
pnpm run build
|
|
```
|
|
|
|
At this point you are now ready to begin developing and testing. All of the build outputs are cached running `pnpm run build` again will only build the plugins, packages, and tools that have changed since the last time you ran the command.
|
|
|
|
Check out [our development guide](DEVELOPMENT.md) if you would like a more comprehensive look at working in our repository.
|
|
|
|
## Repository Structure
|
|
|
|
- [**Plugins**](plugins): Our repository contains plugins that relate to or otherwise aid in the development of WooCommerce.
|
|
- [**WooCommerce Core**](plugins/woocommerce): The core WooCommerce plugin is available in the plugins directory.
|
|
- [**Packages**](packages): Contained within the packages directory are all of the [PHP](packages/php) and [JavaScript](packages/js) provided for the community. Some of these are internal dependencies and are marked with an `internal-` prefix.
|
|
- [**Tools**](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.
|
|
|
|
## Reporting Security Issues
|
|
|
|
To disclose a security issue to our team, [please submit a report via HackerOne here](https://hackerone.com/automattic/).
|
|
|
|
## 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](https://docs.woocommerce.com/document/woocommerce-self-service-guide/).
|
|
- The [WooCommerce.com premium support portal](https://woocommerce.com/contact-us/) for customers who have purchased themes or extensions.
|
|
- [Our community forum on wp.org](https://wordpress.org/support/plugin/woocommerce) which is available for all WooCommerce users.
|
|
- [The Official WooCommerce Facebook Group](https://www.facebook.com/groups/advanced.woocommerce).
|
|
- For customizations, you may want to check our list of [WooExperts](https://woocommerce.com/experts/) or [Codeable](https://codeable.io/).
|
|
|
|
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
|
|
|
|
For peer to peer support, real-time announcements, and office hours, please [join our slack community](https://woocommerce.com/community-slack/)!
|
|
|
|
## Contributing to WooCommerce
|
|
|
|
If you have a patch or have stumbled upon an issue with WooCommerce core, you can contribute this back to the code. Please read our [contributor guidelines](https://github.com/woocommerce/woocommerce/blob/trunk/.github/CONTRIBUTING.md) for more information on how you can do this.
|