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

Harmonize cypress script example names cy: #5787

Merged

Conversation

MikeMcC399
Copy link
Contributor

Issue

The section Getting Started > Opening the App > Adding npm Scripts uses the following examples as script names:

  • cypress:open
  • cypress:run

whereas all other examples of script names on the documentation site use cy:open or cy:run.

Change

Change the script name examples in the section Getting Started > Opening the App > Adding npm Scripts to use the following script names:

  • cy:open
  • cy:run

This harmonizes the example usage with the rest of the documentation site. It is also in line with the usage in cypress-io/cypress-example-kitchensink > package.json.


BEFORE
npm scripts before


AFTER
npm scripts after

Copy link

netlify bot commented Apr 5, 2024

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 36eeddb

@cypress-app-bot
Copy link
Collaborator

Copy link

netlify bot commented Apr 5, 2024

Deploy Preview for benevolent-cat-040f48 ready!

Name Link
🔨 Latest commit 8e59218
🔍 Latest deploy log https://app.netlify.com/sites/benevolent-cat-040f48/deploys/660fd49b67af4200089e68fe
😎 Deploy Preview https://deploy-preview-5787--benevolent-cat-040f48.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 5, 2024 10:45
@MikeMcC399 MikeMcC399 marked this pull request as draft April 7, 2024 08:06
@jennifer-shehane
Copy link
Member

@MikeMcC399 Is this ready for review?

@MikeMcC399
Copy link
Contributor Author

@jennifer-shehane

I'm probably going to suggest re-doing this section, so this PR may become obsolete in the long run. You can ignore it so long as it is in draft. Thanks!

@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 19, 2024 14:49
@MikeMcC399
Copy link
Contributor Author

I'm putting this minor PR up for review now as it may be a while before I get back to contributing other content here.

Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@jennifer-shehane jennifer-shehane merged commit b221c90 into cypress-io:main Apr 19, 2024
3 checks passed
@MikeMcC399 MikeMcC399 deleted the harmonize-script-example-name branch April 19, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants