452c522b95
* Fix Gutenberg links in the docs pointing to the wrong branch * Add changefile(s) from automation for the following project(s): @woocommerce/notices, @woocommerce/eslint-plugin, @woocommerce/dependency-extraction-webpack-plugin, @woocommerce/components, woocommerce-blocks, woocommerce-beta-tester, woo-ai * Fix markdown lint errors * Fix wrong link in the docs --------- Co-authored-by: github-actions <github-actions@github.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| block-assets.md | ||
| coding-guidelines.md | ||
| components.md | ||
| css-build-system.md | ||
| documentation-guidelines.md | ||
| e2e-guidelines.md | ||
| folder-structure.md | ||
| getting-started.md | ||
| javascript-build-system.md | ||
| javascript-testing.md | ||
| storybook-and-components.md | ||
README.md
Contributing
If you're a developer or contributor eager to get started with WooCommerce Block Development, this documentation folder is your perfect starting point.
Navigating this section
Getting Started
The Getting Started guide is your first step in this journey. This document provides comprehensive information about the tooling you'll need and the process of creating builds during the development phase.
Coding Guidelines
A set of guidelines exist to ensure development consistency and quality. The Coding Guidelines doc is your resource for understanding these best practices.
JavaScript Testing
Testing plays a crucial role in development. Our JavaScript Testing guide will walk you through the process of running automated JavaScript tests, providing a robust framework to ensure your code meets the requisite standards.
E2E Testing Guidelines
The E2E Testing Guidelines document offers a detailed understanding of the best practices related to End-to-End tests. E2E testing is a critical aspect of ensuring overall system integrity and functionality.
Developing Components (& Storybook)
For insight into our reusable components, their usage, and how to test them in Storybook, refer to the Developing Components (& Storybook) guide.
Block Script Assets
The Block Script Assets document elucidates how Block Script Assets are loaded and used in the development process. This guide is vital to understanding the role of script assets in block development.
JavaScript Build System
Our JavaScript Build System guide offers a detailed explanation of how JavaScript files are built. This is a crucial read for understanding the behind-the-scenes operations of your code.
CSS Build System
Last but not least, to get an insight into how CSS is built, refer to the CSS Build System guide. A firm grasp of this will ensure your CSS files meet the standards and quality expected.
We're hiring! Come work with us!
🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.