cypress-io / cypress-example-kitchensink

This is an example app used to showcase Cypress.io testing.
https://example.cypress.io/
MIT License
1.22k stars 2.2k forks source link

docs: restructure run tests documentation #862

Closed MikeMcC399 closed 2 months ago

MikeMcC399 commented 2 months ago

Goals

In the README the goals are:

Change

This PR restructures the README section about running tests.

It starts from a set of instructions to clone and run, which can be simply copied and pasted. It explains then in more detail about options and what happens behind the scenes.

Local testing and CI testing are clearly separated.

Documentation and getting help are also separated from the instructions about running tests.

The link to the 5 year old CHANGELOG_OLD.md in the README is also removed as this is now very old and no longer needed / helpful. The file itself is left in place

cypress-app-bot commented 2 months ago
MikeMcC399 commented 2 months ago

Preview

https://github.com/MikeMcC399/cypress-example-kitchensink/blob/docs-run-tests/README.md#run-tests