woocommerce/plugins/woocommerce-blocks/docs/contributors
Rua Haszard 77aa2a33a3 clarify intentions / purpose of different component folders in docs (https://github.com/woocommerce/woocommerce-blocks/pull/3025)
* add high-level docs about our components & remove stale detail info

* use current collection/folder naming in docs:
- let's rename js/components in a separate PR
- split paragraphs on to separate lines to improve future diffs

* rename storybook.md => components.md and update link/summary

* tweak component collection docs:
- base have more stringent requirements, since they can be used anywhere
- editor components are less strict and can assume editor context

* clarify js/base/components readme in line with main doc

* remove line about editor components being specialised to woo blocks
2020-08-27 08:15:16 +12:00
..
README.md clarify intentions / purpose of different component folders in docs (https://github.com/woocommerce/woocommerce-blocks/pull/3025) 2020-08-27 08:15:16 +12:00
block-assets.md Update references to use main 2020-06-16 10:38:19 +01:00
coding-guidelines.md Update base/components classnames (https://github.com/woocommerce/woocommerce-blocks/pull/2711) 2020-06-17 11:53:42 +02:00
components.md clarify intentions / purpose of different component folders in docs (https://github.com/woocommerce/woocommerce-blocks/pull/3025) 2020-08-27 08:15:16 +12:00
css-build-system.md Add Webpack config docs (https://github.com/woocommerce/woocommerce-blocks/pull/3043) 2020-08-25 12:01:19 +02:00
getting-started.md Add section on configuring WordPress site 2020-08-05 08:37:49 -04:00
javascript-testing.md Update javascript-testing.md 2020-07-03 08:11:00 -04:00
js-build-system.md Add Webpack config docs (https://github.com/woocommerce/woocommerce-blocks/pull/3043) 2020-08-25 12:01:19 +02:00
smoke-testing.md Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) 2020-01-31 12:48:11 +00:00

README.md

Contributing

This folder contains documentation for developers and contributors looking to get started with WooCommerce Block Development.

Document Description
Getting Started This doc covers tooling and creating builds during development.
Coding Guidelines This doc covers development best practices.
Smoke Testing This doc explains how to smoke test key Blocks functionality.
JavaScript Testing This doc explains how to run automated JavaScript tests.
Developing Components (& Storybook) This doc outlines where our reusable components live, and how to test them in Storybook.
Block Script Assets This doc explains how Block Script Assets are loaded and used.
JS build system This doc explains how JavaScript files are built.
CSS build system This doc explains how CSS is built.