8b35b0785c
* Make sure the WC Shipping slug is used for installation * Make sure the check to show banner metabox work for HPOS as well * Make ShippingLabelBannerDisplayRules::order_has_shippable_products work with HPOS as well * Remove Jetpack plugin specific checks in ShippingLabelBannerDisplayRules * Use correct variable names for dotcom connection * Fix comments * Remove depenency on WCS&T for showing WC Shipping promo banner * Remove WC Tax and WC Shipping from incompatible plugins * Vary action button label if WCS&T is already installed * Inject config and render label purchase app after activation * Open the purchase modal after adding it to DOM * Render Shipment tracking metabox * Use a different headline when WCS&T is already installed * Fix UX when a none-compatible WCS&T is already active * Fix CSS linting issues * Fix Jslint issues * Improve around usage of localized variables * Fix and update JS tests * Address phpcs issues * Delete metaboxes of compatible WCS&T * Remove redundant variable assignment * Remove css and js of WCS&T if a compatible version is installed * Fix failing legacy PHPUnit tests * Only open the new label purchase modal if WCS&T is not active * Remove redundant code around TOS acceptance for showing the banner * Remove redundant test for Jetpack version checking * Make sure target passed to MutationObserver.observe is available * Add changelog file * Add openWcsModal to component's prototype * Add more js unit tests * Address PHP notice * Remove redundant variable assignments * Rename wcsPluginSlug to more clear wcShippingPluginSlug * Add a link to plugins page if incompatible WCS&T is already installed * Remove unused function parameters * Fix API resource path * Handle a case where none compatible version of WCShipping is installed |
||
---|---|---|
.github | ||
.husky | ||
bin | ||
changelog | ||
docs | ||
packages | ||
plugins | ||
tools | ||
.codecov.yml | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.markdownlint.json | ||
.markdownlintignore | ||
.npmrc | ||
.nvmrc | ||
.pnpmfile.cjs | ||
.prettierrc.js | ||
.stylelintrc | ||
.syncpackrc | ||
CODEOWNERS | ||
CODE_OF_CONDUCT.md | ||
DEVELOPMENT.md | ||
README.md | ||
SECURITY.md | ||
changelog.txt | ||
package.json | ||
phpcs.xml | ||
pnpm-lock.yaml | ||
pnpm-workspace.yaml | ||
renovate.json | ||
tsconfig.base.json |
README.md
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 to stay up to date about everything happening in the project. You can also follow @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: 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 which helps ensure you are using the correct version of Node. - 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 features a minimum PHP version of 7.4. 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.
Once you've installed all of the prerequisites, you can run the following commands to get everything working.
# 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 build
At this point you are now ready to begin developing and testing. All of the build outputs are cached running pnpm 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 if you would like a more comprehensive look at working in our repository.
Repository Structure
- 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.
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
For peer to peer support, real-time announcements, and office hours, please join our slack community!
Contributing to WooCommerce
As an open source project, we rely on community contributions to continue to improve WooCommerce. To contribute, please follow the pre-requisites above and visit our Contributing to Woo doc for more links and contribution guidelines.