Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: restructure run tests documentation #862

Merged
merged 1 commit into from
Jul 24, 2024

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Jul 22, 2024

Goals

In the README the goals are:

  • simplification for first-time users
  • more clarity in the documentation between local / CI testing, usage and support
  • preparation to add information about running Docker, so that the structures will be able to fit. (The plan is to mark the CI examples which use Docker and add explicit instructions about running the repo in Docker locally.)

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
Copy link
Collaborator

@MikeMcC399 MikeMcC399 marked this pull request as ready for review July 22, 2024 09:33
@MikeMcC399

This comment was marked as outdated.

@jennifer-shehane jennifer-shehane merged commit f3ef947 into cypress-io:master Jul 24, 2024
14 checks passed
@MikeMcC399 MikeMcC399 deleted the docs-run-tests branch July 25, 2024 15:19
@cypress-app-bot
Copy link
Collaborator

🎉 This PR is included in version 3.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants