From 5fc5d2e209fd0330742f2bc87b8cd8794e44259c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 4 Nov 2024 03:57:55 -0800 Subject: [PATCH] Apply suggestions from code review --- docs/source/development/add-ons/test-add-ons-18.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/development/add-ons/test-add-ons-18.md b/docs/source/development/add-ons/test-add-ons-18.md index 565f3921e8..cb55a72ad3 100644 --- a/docs/source/development/add-ons/test-add-ons-18.md +++ b/docs/source/development/add-ons/test-add-ons-18.md @@ -16,7 +16,7 @@ This guide assumes that you've used {term}`Cookieplone` to create your add-on bo Volto uses {term}`Jest` for unit tests. You can create unit tests for testing your add-on. -Run the following command: +Run the following command. ```shell make test @@ -25,7 +25,7 @@ make test ## Override Jest configuration In {term}`CI` or for testing add-ons, it's useful to modify Jest's {file}`package.json` configuration file. -You can use the boilerplate provided {file}`jest.config.js` file. +You can use the file {file}`jest.config.js` provided by the boilerplate. The test command will load it and apply it. ```{warning} @@ -35,7 +35,7 @@ Do not modify the existing keys in there if you don't know what you are doing, s Both configurations are merged in a way that the keys of the configuration provided override the initial {file}`package.json` configuration, either in Volto or in your projects. ```{note} -For more background on testing add-ons in Volto 18, see {doc}`../../contributing/testing` since the developer experience has been unified for both add-ons and Volto core. +For more background on testing add-ons in Volto 18, see {doc}`../../contributing/testing`, since the developer experience has been unified for both add-ons and Volto core. ``` ### Acceptance tests @@ -43,19 +43,19 @@ For more background on testing add-ons in Volto 18, see {doc}`../../contributing Use {term}`Cypress` to run acceptance tests. To start the backend server, run the following command. -This will start a docker container with a vanilla Plone backend. +This will start a Docker container with a vanilla Plone backend. ```shell make acceptance-backend-start ``` -To start the frontend acceptance server (in development mode), run the following command. +To start the frontend acceptance server in development mode, run the following command. ```shell make acceptance-frontend-dev-start ``` -You run the frontend in development mode, so you can develop while writing tests. +You can run the frontend in development mode, so you can develop while writing tests. Run the following command to run Cypress tests afterward. ```shell