Update README.md and CONTRIBUTING.md (https://github.com/woocommerce/woocommerce-admin/pull/5772)
* Update README.md and CONTRIBUTING.md * Add note about WooCommerce development environment
This commit is contained in:
parent
c86563c3ac
commit
99aa5ddfba
|
@ -54,13 +54,16 @@ After you've made your updates, you're ready to commit:
|
|||
|
||||
## PHP Unit tests
|
||||
|
||||
### Setting up PHP unit tests using VVV
|
||||
### Setting up PHP unit tests using [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV)
|
||||
|
||||
1. SSH into the Vagrant box:
|
||||
1. `cd` down to the Vagrant root (where `www` lives)
|
||||
2. `vagrant ssh`
|
||||
2. `cd /srv/www/<name of wp install>/public_html/wp-content/plugins/woocommerce-admin`
|
||||
3. `bin/install-wp-tests.sh wc-admin-tests root root`
|
||||
3. Set up test environment: `bin/install-wp-tests.sh wc-admin-tests root root`
|
||||
4. Generate feature config: `php bin/generate-feature-config.php`
|
||||
|
||||
*Note: A WooCommerce development environment is required to live within the same `plugins` folder. Follow these [steps](https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment) to do so.*
|
||||
|
||||
### Running tests
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@ For some debugging tools/help [see here](./CONTRIBUTING.md#debugging)
|
|||
|
||||
### Testing
|
||||
#### End-to-end tests
|
||||
Tests live in `./tests/e2e`. E2E tests have their own Docker container to run the WordPress server. Start
|
||||
Tests live in `./tests/e2e`. An existing build is required prior running, please refer to the section above for steps. E2E tests have their own Docker container to run the WordPress server. Start
|
||||
the server using:
|
||||
```
|
||||
npm run docker:up
|
||||
|
@ -46,6 +46,9 @@ Run a single test by adding the file name:
|
|||
npm run test:e2e-dev complete-onboarding-wizard.test.js
|
||||
```
|
||||
|
||||
## Common Issues
|
||||
If you're encountering any issue setting things up, chances are we have been there too. Please have a look at our [wiki](https://github.com/woocommerce/woocommerce-admin/wiki/Common-Issues) for a list of common problems.
|
||||
|
||||
## Privacy
|
||||
|
||||
If you have enabled WooCommerce usage tracking ( option `woocommerce_allow_tracking` ) then, in addition to the tracking described in https://woocommerce.com/usage-tracking/, this plugin also sends information about the actions that site administrators perform to Automattic - see https://automattic.com/privacy/#information-we-collect-automatically for more information.
|
||||
|
|
Loading…
Reference in New Issue