Table of Contents
Table of Contents
SCSS
When updating SCSS files in the WooCommerce project, please commit only your changes to unminified SCSS files. The minification will be handled as part of the release process.
To get the minified CSS files, run pnpm -- turbo run build --filter='woocommerce-legacy-assets'
from the repository root directory. To set up the development environment from scratch, see the section on how to install dependencies and generate assets in the guide to set up a WooCommerce development environment.
Javascript
When changing the JS files, please commit only unminified files (i.e. the readable JS files). The minification will be handled as part of the release process.
To ensure you can test your changes, run with SCRIPT_DEBUG
turned on, i.e. add define( 'SCRIPT_DEBUG', true );
to your wp-config.php file.
Contribution
- Set up development environment
- Our Git Flow
- SCSS and JS minification
- Naming conventions
- CSS SASS coding guidelines and naming conventions
- Critical Flows
- API Critical Flows
- String localisation guidelines
- Translating WooCommerce
- Deprecation in core
- Adding Actions and Filters
- Common Issues
- Writing high-quality testing instructions
Release Notes
- Release Testing Instructions
- 3.6.x notes/FAQ
- 2.6.x to 3.0.0 Developer Migration Notes
- Select2 fields not working in 3.0.x
- Thumbnail Image Regeneration in 3.3+
- Customizing image sizes in 3.3+
REST API and CLI
CRUD & Data Descriptions
- Database Description
- CRUD Objects in 3.0
- Order and Order Line Item Data
- Coupon Data
- Customer Data
- Product Data
- Data Stores
Internal APIs
Theming
- Enabling product gallery features (zoom, swipe, lightbox)
- Template File Guidelines for Devs and Theme Authors
Examples / Guides
WooCommerce is an open source commerce platform built for WordPress and lovingly crafted by Automattic and the WooCommerce community 💜. Come and work with us!