From c412cf5283fcb2cbefcee11d269f12ed32d03f86 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 12:21:57 -0300 Subject: [PATCH 01/11] Add some examples to the docs --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 11516949..a826a94f 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,13 @@ _(Pro Tip: Opting for the Composer installation method simplifies the process of 3. Move the file to a directory in your PATH, such as `sudo mv qit /usr/local/bin/qit` 4. Run `qit` to authenticate with your WooCommerce.com Partner Developer account. -## Documentation +## Examples -For more detailed information on QIT and how to use it, refer to the [official documentation](https://woocommerce.github.io/qit-documentation/#/). +- `qit run:e2e my-extension` - Runs the WooCommerce Core E2E tests with your extension active. +- `qit run:e2e my-extension --php_version=8.2` - Same as above, but with PHP 8.2. +- `qit run:e2e my-extension --php_version=8.2 --woocommerce_version=rc --wordpress_version=rc` - Same as above, but with PHP 8.2, and the release candidate versions of WooCommerce and WordPress, if they are available. +- `qit run:e2e my-extension --zip` - Runs the tests using your development build zip, that is still unreleased. +- `qit run:e2e my-extension --additional_wordpress_plugins=gutenberg` - Activates the "Gutenberg" feature plugin in the test environment as well. ### Supported Tests @@ -47,8 +51,13 @@ QIT currently supports the following types of tests: - [PHPStan Test](https://woocommerce.github.io/qit-documentation/#/test-types/phpstan) - [API Test](https://woocommerce.github.io/qit-documentation/#/test-types/api) - Compatibility Test +- _PHP Minimum and Maximum Version Compatibility (Coming soon)_ - _Performance Test (Coming soon)_ +## Documentation + +For more detailed information on QIT and how to use it, refer to the [official documentation](https://woocommerce.github.io/qit-documentation/#/). + ### Highlights #### For End-to-End, Activation, and API Tests From 86af8c933548054db807f05c4541a31270b4ab11 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 12:34:34 -0300 Subject: [PATCH 02/11] Add section about QIT being exclusive to WCCOM for now --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a826a94f..8b8a3217 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,12 @@ QIT currently supports the following types of tests: For more detailed information on QIT and how to use it, refer to the [official documentation](https://woocommerce.github.io/qit-documentation/#/). +## Is this tool exclusive to WooCommerce.com Partner Developers? + +QIT is an innovative initiative aimed at enhancing the accessibility of automated testing for developers. Our ultimate aspiration is to extend the benefits of this tool to a wider circle of WordPress developers, thereby strengthening the entire ecosystem. + +However, as we find ourselves in the preliminary phase of this project, we are currently extending this offering solely to our WooCommerce.com Partner Developers. If you're eager to utilize QIT and want to voice your interest, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. We deeply value your feedback as it plays a critical role in shaping the future of our project. + ### Highlights #### For End-to-End, Activation, and API Tests From 895c885c817e0c339fb3409ef83d3838a8cb213e Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 12:36:15 -0300 Subject: [PATCH 03/11] Move section --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8b8a3217..cc75a52f 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,6 @@ QIT currently supports the following types of tests: For more detailed information on QIT and how to use it, refer to the [official documentation](https://woocommerce.github.io/qit-documentation/#/). -## Is this tool exclusive to WooCommerce.com Partner Developers? - -QIT is an innovative initiative aimed at enhancing the accessibility of automated testing for developers. Our ultimate aspiration is to extend the benefits of this tool to a wider circle of WordPress developers, thereby strengthening the entire ecosystem. - -However, as we find ourselves in the preliminary phase of this project, we are currently extending this offering solely to our WooCommerce.com Partner Developers. If you're eager to utilize QIT and want to voice your interest, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. We deeply value your feedback as it plays a critical role in shaping the future of our project. - ### Highlights #### For End-to-End, Activation, and API Tests @@ -77,6 +71,12 @@ However, as we find ourselves in the preliminary phase of this project, we are c - Integrate QIT as part of your pull requests with our example [GitHub Workflows integration](https://woocommerce.github.io/qit-documentation/#/workflows/getting-started). - Create and share application passwords with your development team, allowing them to use the QIT CLI without having full access to your WooCommerce.com account. +## Is this tool exclusive to WooCommerce.com Partner Developers? + +QIT is an innovative initiative aimed at enhancing the accessibility of automated testing for developers. Our ultimate aspiration is to extend the benefits of this tool to a wider circle of WordPress developers, thereby strengthening the entire ecosystem. + +However, as we find ourselves in the preliminary phase of this project, we are currently extending this offering solely to our WooCommerce.com Partner Developers. If you're eager to utilize QIT and want to voice your interest, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. We deeply value your feedback as it plays a critical role in shaping the future of our project. + ## Support If you need help with QIT, open an issue on this [GitHub repository](https://github.com/woocommerce/qit-cli/issues/new). From db6e5f722184576a65e9ea7fe51dfc14fd77d883 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 12:39:38 -0300 Subject: [PATCH 04/11] Link to updating QIT --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc75a52f..cd6190db 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ You can install QIT in three different ways: ### Globally Using `wget` -_(Pro Tip: Opting for the Composer installation method simplifies the process of updating QIT in the future 😉)_ +_(Pro Tip: Opting for the Composer installation method simplifies the process of [updating QIT](https://woocommerce.github.io/qit-documentation/#/cli/getting-started?id=updating-qit) in the future 😉)_ 1. Run `wget https://github.com/woocommerce/qit-cli/raw/trunk/qit` 2. Execute `chmod +x qit` 3. Move the file to a directory in your PATH, such as `sudo mv qit /usr/local/bin/qit` From 695a9f24783091c9421ba6d4c73bbc5388ede4d0 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:37:22 -0300 Subject: [PATCH 05/11] CR tweaks --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cd6190db..c2e75772 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ _(Pro Tip: Opting for the Composer installation method simplifies the process of - `qit run:e2e my-extension` - Runs the WooCommerce Core E2E tests with your extension active. - `qit run:e2e my-extension --php_version=8.2` - Same as above, but with PHP 8.2. -- `qit run:e2e my-extension --php_version=8.2 --woocommerce_version=rc --wordpress_version=rc` - Same as above, but with PHP 8.2, and the release candidate versions of WooCommerce and WordPress, if they are available. -- `qit run:e2e my-extension --zip` - Runs the tests using your development build zip, that is still unreleased. +- `qit run:e2e my-extension --php_version=8.2 --woocommerce_version=rc --wordpress_version=rc` - Same as above, but with the release candidate versions of WooCommerce and WordPress, or latest stable if there are no RC releases available. +- `qit run:e2e my-extension --zip` - Runs the tests using an unreleased development build zip. - `qit run:e2e my-extension --additional_wordpress_plugins=gutenberg` - Activates the "Gutenberg" feature plugin in the test environment as well. ### Supported Tests @@ -50,7 +50,6 @@ QIT currently supports the following types of tests: - [Security Test](https://woocommerce.github.io/qit-documentation/#/test-types/security) - [PHPStan Test](https://woocommerce.github.io/qit-documentation/#/test-types/phpstan) - [API Test](https://woocommerce.github.io/qit-documentation/#/test-types/api) -- Compatibility Test - _PHP Minimum and Maximum Version Compatibility (Coming soon)_ - _Performance Test (Coming soon)_ @@ -73,9 +72,11 @@ For more detailed information on QIT and how to use it, refer to the [official d ## Is this tool exclusive to WooCommerce.com Partner Developers? -QIT is an innovative initiative aimed at enhancing the accessibility of automated testing for developers. Our ultimate aspiration is to extend the benefits of this tool to a wider circle of WordPress developers, thereby strengthening the entire ecosystem. +QIT is an innovative initiative aimed at enhancing the accessibility of automated testing for WordPress developers. -However, as we find ourselves in the preliminary phase of this project, we are currently extending this offering solely to our WooCommerce.com Partner Developers. If you're eager to utilize QIT and want to voice your interest, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. We deeply value your feedback as it plays a critical role in shaping the future of our project. +In this initial phase, we've started with bringing this to Woo Marketplace Partner Developers. Our ultimate aspiration is to extend the benefits of this tool to a wider circle of WordPress developers, thereby strengthening the entire ecosystem. + +If you're eager to utilize QIT and want to voice your interest, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. We deeply value your feedback as it plays a critical role in shaping the future of our project. ## Support From 8667b5cfa1c5a53405261a203ae8a756197c8db7 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:46:00 -0300 Subject: [PATCH 06/11] Doc tweaks --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2e75772..ff9c8ea1 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,12 @@ _(Pro Tip: Opting for the Composer installation method simplifies the process of - `qit run:e2e my-extension` - Runs the WooCommerce Core E2E tests with your extension active. - `qit run:e2e my-extension --php_version=8.2` - Same as above, but with PHP 8.2. -- `qit run:e2e my-extension --php_version=8.2 --woocommerce_version=rc --wordpress_version=rc` - Same as above, but with the release candidate versions of WooCommerce and WordPress, or latest stable if there are no RC releases available. +- `qit run:e2e my-extension --php_version=8.2 --woocommerce_version=rc --wordpress_version=rc` - Same as above, but with the release candidate versions of WooCommerce and WordPress, or latest stable if none available. - `qit run:e2e my-extension --zip` - Runs the tests using an unreleased development build zip. - `qit run:e2e my-extension --additional_wordpress_plugins=gutenberg` - Activates the "Gutenberg" feature plugin in the test environment as well. +- `qit run:e2e my-extension --optional_features=hpos` - Enables the WooCommerce "High Performance Order Storage" in the test site. + +You can use these parameter individually or in combination to create different scenarios for your tests. Run `qit run: --help` to see all the available options. Different test types will have different options to choose from. ### Supported Tests From 96fdaac3d859202b07491892dc468d2d0f9d063f Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:52:27 -0300 Subject: [PATCH 07/11] Tweak wording --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ff9c8ea1..79981644 100644 --- a/README.md +++ b/README.md @@ -73,13 +73,13 @@ For more detailed information on QIT and how to use it, refer to the [official d - Integrate QIT as part of your pull requests with our example [GitHub Workflows integration](https://woocommerce.github.io/qit-documentation/#/workflows/getting-started). - Create and share application passwords with your development team, allowing them to use the QIT CLI without having full access to your WooCommerce.com account. -## Is this tool exclusive to WooCommerce.com Partner Developers? +## Is QIT Exclusively Available for WooCommerce.com Partner Developers? -QIT is an innovative initiative aimed at enhancing the accessibility of automated testing for WordPress developers. +QIT represents a revolutionary step forward in facilitating automated testing for WordPress developers. -In this initial phase, we've started with bringing this to Woo Marketplace Partner Developers. Our ultimate aspiration is to extend the benefits of this tool to a wider circle of WordPress developers, thereby strengthening the entire ecosystem. +In its inaugural phase, we've chosen to primarily target Woo Marketplace Partner Developers. However, our broader vision encompasses extending the availability of this tool to plugins outside of the Marketplace as well, in a commitment to make automated testing accessible to the WordPress ecosystem as a whole. -If you're eager to utilize QIT and want to voice your interest, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. We deeply value your feedback as it plays a critical role in shaping the future of our project. +Should you be interested in leveraging the potential of QIT and wish to express your support for its broader application, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. Your input is invaluable to us, as it greatly contributes to directing the course of our project's future. ## Support From 539d1ec8abecae0ac54abb47b40c61edeecebb95 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:53:46 -0300 Subject: [PATCH 08/11] Wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 79981644..35b9ddbf 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ QIT represents a revolutionary step forward in facilitating automated testing fo In its inaugural phase, we've chosen to primarily target Woo Marketplace Partner Developers. However, our broader vision encompasses extending the availability of this tool to plugins outside of the Marketplace as well, in a commitment to make automated testing accessible to the WordPress ecosystem as a whole. -Should you be interested in leveraging the potential of QIT and wish to express your support for its broader application, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. Your input is invaluable to us, as it greatly contributes to directing the course of our project's future. +Should you be interested in leveraging the potential of QIT and wish to express your support for its broader application, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. Your input is invaluable to us, as it greatly contributes to directing the course of the project's future. ## Support From b1f42daf3a6698d5cb8cbb178bbbda92fb3a6ce0 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:59:28 -0300 Subject: [PATCH 09/11] Update README.md Co-authored-by: Greg <71906536+zhongruige@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35b9ddbf..434515f8 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ _(Pro Tip: Opting for the Composer installation method simplifies the process of - `qit run:e2e my-extension --additional_wordpress_plugins=gutenberg` - Activates the "Gutenberg" feature plugin in the test environment as well. - `qit run:e2e my-extension --optional_features=hpos` - Enables the WooCommerce "High Performance Order Storage" in the test site. -You can use these parameter individually or in combination to create different scenarios for your tests. Run `qit run: --help` to see all the available options. Different test types will have different options to choose from. +You can use these parameters individually or in combination to create different scenarios for your tests. Run `qit run: --help` to see all the available options. Different test types will have different options to choose from. ### Supported Tests From 2dd7e1d40380a9dea00ee99781a05ef4ffc91741 Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:59:43 -0300 Subject: [PATCH 10/11] Update README.md Co-authored-by: Greg <71906536+zhongruige@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 434515f8..9ee61e8e 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ _(Pro Tip: Opting for the Composer installation method simplifies the process of - `qit run:e2e my-extension --php_version=8.2 --woocommerce_version=rc --wordpress_version=rc` - Same as above, but with the release candidate versions of WooCommerce and WordPress, or latest stable if none available. - `qit run:e2e my-extension --zip` - Runs the tests using an unreleased development build zip. - `qit run:e2e my-extension --additional_wordpress_plugins=gutenberg` - Activates the "Gutenberg" feature plugin in the test environment as well. -- `qit run:e2e my-extension --optional_features=hpos` - Enables the WooCommerce "High Performance Order Storage" in the test site. +- `qit run:e2e my-extension --optional_features=hpos` - Enables the [WooCommerce "High Performance Order Storage"](https://developer.woocommerce.com/roadmap/high-performance-order-storage/) feature in the test site. You can use these parameters individually or in combination to create different scenarios for your tests. Run `qit run: --help` to see all the available options. Different test types will have different options to choose from. From ede840a8c313013cbd0238e4a971a17b9c87b2ba Mon Sep 17 00:00:00 2001 From: Lucas Bustamante Date: Mon, 22 May 2023 13:59:54 -0300 Subject: [PATCH 11/11] Update README.md Co-authored-by: Greg <71906536+zhongruige@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ee61e8e..926af664 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ QIT represents a revolutionary step forward in facilitating automated testing fo In its inaugural phase, we've chosen to primarily target Woo Marketplace Partner Developers. However, our broader vision encompasses extending the availability of this tool to plugins outside of the Marketplace as well, in a commitment to make automated testing accessible to the WordPress ecosystem as a whole. -Should you be interested in leveraging the potential of QIT and wish to express your support for its broader application, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. Your input is invaluable to us, as it greatly contributes to directing the course of the project's future. +If you're interested in leveraging the potential of QIT and want to further support its broader goals, we welcome you to [submit an issue](https://github.com/woocommerce/qit-cli/issues) in our GitHub repository. Your input is invaluable to us, as it greatly contributes to directing the course of the project's future. ## Support