From cb3a2cc0563052c94e35dc71efa4da01438cdf15 Mon Sep 17 00:00:00 2001 From: Niels Lange Date: Fri, 26 May 2023 22:16:18 +0700 Subject: [PATCH] Update README.md --- .../docs/contributors/README.md | 43 +++++++++++++------ 1 file changed, 31 insertions(+), 12 deletions(-) diff --git a/plugins/woocommerce-blocks/docs/contributors/README.md b/plugins/woocommerce-blocks/docs/contributors/README.md index 4d81636218b..16426ec9415 100644 --- a/plugins/woocommerce-blocks/docs/contributors/README.md +++ b/plugins/woocommerce-blocks/docs/contributors/README.md @@ -1,19 +1,38 @@ # Contributing -This folder contains documentation for developers and contributors looking to get started with WooCommerce Block Development. +If you're a developer or contributor eager to get started with WooCommerce Block Development, this documentation folder is your perfect starting point. -| Document | Description | -|------------------------------------------------------------| ---------------------------------------------------------------------------------------- | -| [Getting Started](contributing/getting-started.md) | This doc covers tooling and creating builds during development. | -| [Coding Guidelines](contributing/coding-guidelines.md) | This doc covers development best practices. | -| [JavaScript Testing](contributing/javascript-testing.md) | This doc explains how to run automated JavaScript tests. | -| [E2E Testing Guidelines](contributing/e2e-guidelines.md) | This doc covers development best practices about E2E tests. | -| [Developing Components (& Storybook)](components.md) | This doc outlines where our reusable components live, and how to test them in Storybook. | -| [Block Script Assets](contributing/block-assets.md) | This doc explains how Block Script Assets are loaded and used. | -| [JS build system](contributing/javascript-build-system.md) | This doc explains how JavaScript files are built. | -| [CSS build system](contributing/css-build-system.md) | This doc explains how CSS is built. | +### Getting Started - +The [Getting Started](contributing/getting-started.md) 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](contributing/coding-guidelines.md) doc is your resource for understanding these best practices. + +### JavaScript Testing + +Testing plays a crucial role in development. Our [JavaScript Testing](contributing/javascript-testing.md) guide will walk you through the process of running automated JavaScript tests, providing a robust framework to ensure your code meets the requisite standards. + +### End-to-End (E2E) Testing Guidelines + +The [E2E Testing Guidelines](contributing/e2e-guidelines.md) 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 and Storybook + +For insight into our reusable components, their usage, and how to test them in Storybook, refer to the [Developing Components (& Storybook)](components.md) guide. + +### Block Script Assets + +The [Block Script Assets](contributing/block-assets.md) 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](contributing/javascript-build-system.md) 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](contributing/css-build-system.md) guide. A firm grasp of this will ensure your CSS files meet the standards and quality expected. ---