Skip to content

Commit

Permalink
Merge pull request #159 from woocommerce/readme-tweaks
Browse files Browse the repository at this point in the history
Readme suggestions
  • Loading branch information
Luc45 authored Apr 5, 2024
2 parents 56a9e97 + fc657f9 commit 1ecdf31
Showing 1 changed file with 35 additions and 18 deletions.
53 changes: 35 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,50 @@

<p align="center"><img src="https://woo.com/wp-content/themes/woo/images/logo-woocommerce-bubble.svg" alt="WooCommerce" style="width:100px;height:auto;"></p>

## Documentation
## Quality Insights Toolkit (QIT)

For more detailed information on QIT and how to use it, refer to the [documentation](https://qit.woo.com/docs/).
QIT is a testing platform for WordPress Plugins and Themes developed by WooCommerce, designed to simplify and streamline your testing process. We are currently in closed beta operating only in the Woo Marketplace.

## Quality Insights Toolkit (QIT)
#### Managed Tests

Run tests out-of-the box with zero configuration.

- [Woo E2E Test](https://qit.woo.com/docs/test-types/woo-e2e) - Runs WooCommerce End-to-End tests alongside your extension.
- [Woo API Test](https://qit.woo.com/docs/test-types/woo-api) - Runs WooCommerce API tests with your extension.
- [Activation Test](https://qit.woo.com/docs/test-types/activation) - Activates your plugin and logs any PHP notice, warning, and error.
- [Security Test](https://qit.woo.com/docs/test-types/security) - Scan your plugin for adherence to best practices in writing secure code.
- [PHPStan Test](https://qit.woo.com/docs/test-types/phpstan) - Run PHPStan checks to catch issues early.
- [PHP Compatibility Test](https://qit.woo.com/docs/test-types/phpcompatibility) - Run PHPCompatibility tests to detect issues with different PHP versions.
- [Malware Test](https://qit.woo.com/docs/test-types/malware) - Scan your code with the Malware check.
- _Performance Tests (Work-in-progress)_

#### **Custom E2E Tests** _(Coming Soon)_

Write your own E2E tests using frameworks such as [Playwright](https://playwright.dev/), or leverage pre-built tests to effortlessly increase your test coverage.

[Read more about Custom E2E Tests](https://qit.woo.com/docs/custom-tests/introduction).

#### Local Test Environment _(Coming Soon)_

Fast, disposable and configurable test environment designed to do one thing well: **Run tests.**

Our Alpine-based Docker images are perfect for CI systems, while also offering native ARM64 support for Apple Silicon and optimized Docker volumes for faster performance on Mac, Linux, and Windows WSL for local tests.

[Read more about the Local Test Environment.](https://qit.woo.com/docs/environment/getting-started)

#### And much more:

QIT is a testing platform for WordPress Plugins and Themes developed by WooCommerce that allows developers to run a series of managed tests out-of-the-box. We are currently in closed beta operating only in the Woo Marketplace.

- **Comprehensive Testing Suite**: Includes various tests to ensure thorough quality checks.
- [Woo E2E Test](https://qit.woo.com/docs/test-types/woo-e2e)
- [Woo API Test](https://qit.woo.com/docs/test-types/woo-api)
- [Activation Test](https://qit.woo.com/docs/test-types/activation)
- [Security Test](https://qit.woo.com/docs/test-types/security)
- [PHPStan Test](https://qit.woo.com/docs/test-types/phpstan)
- [PHP Compatibility Test](https://qit.woo.com/docs/test-types/phpcompatibility)
- [Malware Test](https://qit.woo.com/docs/test-types/malware)
- _Performance Tests (Work-in-progress)_
- _Custom E2E Tests (Work-in-progress)_
- **Configurable Environment**: Configurable PHP, WordPress, WooCommerce versions, and more.
- **In-Depth Analysis**: Tracks all PHP notices, warnings, and errors during testing.
- **Feature Flags**: Supports various WooCommerce feature flags for extended coverage.
- **Compatibility Testing**: Support activation of additional WordPress plugins for compatibility testing.
- **Development & Stable Versions**: Test with both development builds and published stable versions.
- **Development & Published Versions**: Test with both development and published versions of your plugins.
- **GitHub Integration**: Integrate QIT into your PR reviews with GitHub Actions.
- **Test Reports**: Detailed test reports to help you understand the results.
- **Notifications**: Stay informed with test result notifications.

## Documentation

For more detailed information on QIT and how to use it, refer to the [documentation](https://qit.woo.com/docs/).

<p align="center">
<img src="https://github.com/woocommerce/qit-cli/assets/9341686/640698a7-01c3-498a-8bb2-7c5e337e0a9c" alt="Qit Quick Demo">
</p>
Expand Down

0 comments on commit 1ecdf31

Please sign in to comment.