Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/docs/contributors/README.md

15 lines
1.7 KiB
Markdown
Raw Normal View History

Update documentation indexes and add checkout docs (https://github.com/woocommerce/woocommerce-blocks/pull/2720) * Fix existing indexes * Update indexes * Stock docs
2020-06-16 15:50:09 +00:00
# Contributing
This folder contains documentation for developers and contributors looking to get started with WooCommerce Block Development.
| Document | Description |
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| [Getting Started](getting-started.md) | This doc covers tooling and creating builds during development. |
| [Coding Guidelines](coding-guidelines.md) | This doc covers development best practices. |
| [Smoke Testing](smoke-testing.md) | This doc explains how to smoke test key Blocks functionality. |
| [JavaScript Testing](javascript-testing.md) | This doc explains how to run automated JavaScript tests. |
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-26 20:15:16 +00:00
| [Developing Components (& Storybook)](components.md) | This doc outlines where our reusable components live, and how to test them in Storybook. |
Update documentation indexes and add checkout docs (https://github.com/woocommerce/woocommerce-blocks/pull/2720) * Fix existing indexes * Update indexes * Stock docs
2020-06-16 15:50:09 +00:00
| [Block Script Assets](block-assets.md) | This doc explains how Block Script Assets are loaded and used. |
Add Webpack config docs (https://github.com/woocommerce/woocommerce-blocks/pull/3043) * Add Webpack config docs * Typo * Add note that aliases make refactors easier * Rewrite 'Relevant files' section of the build system docs
2020-08-25 10:01:19 +00:00
| [JS build system](js-build-system.md) | This doc explains how JavaScript files are built. |
Add docs about CSS build system (https://github.com/woocommerce/woocommerce-blocks/pull/2953) * Add docs to CSS build system * Add docs to CSS build system (II)
2020-08-07 17:57:57 +00:00
| [CSS build system](css-build-system.md) | This doc explains how CSS is built. |