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

Fix typo in CONTRIBUTING.md #5452

Closed
S-Tornqvist opened this issue Aug 30, 2023 · 4 comments
Closed

Fix typo in CONTRIBUTING.md #5452

S-Tornqvist opened this issue Aug 30, 2023 · 4 comments

Comments

@S-Tornqvist
Copy link

Subject

Guides (CONTRIBUTING.md)

Description

The sentence "If you make changes to an npm package that can't be published until the binary is also updated, you should make a pull request against specifying this is not be merged until the scheduled Cypress app release date." in file CONTRIBUTING.md is hard to understand because of incorrect grammar.

@MikeMcC399
Copy link
Contributor

@S-Tornqvist

This is about CONTRIBUTING.md > Committing code in the https://github.com/cypress-io/cypress repo, so the issue should perhaps be moved there.

I would assume that there are some words missing in the sentence. Maybe it is trying to say something like the following?

"If you make changes to an npm package that can't be published until the main Cypress binary is also updated, you should make a pull request against the develop branch specifying that the PR is not be merged until the scheduled Cypress app release date."

@S-Tornqvist
Copy link
Author

Thanks for the feedback, @MikeMcC399. I was not able to create an issue of the proper type within the code repo, because only issues of types 🐛Bug report, ⬇️ Issue during install, ✨ Feature and ❄️ Flaky test in cypress-io/cypress repository are allowed. Would a work around be creating a bug report then changing the contents once posted?

@MikeMcC399
Copy link
Contributor

@S-Tornqvist

Your suggestion is what I have done in the past when I reported problems in the CONTRIBUTING.md file on the main repository. Use the bug report and modify it accordingly.

@S-Tornqvist
Copy link
Author

@MikeMcC399

Okay, thanks! Closing this issue then.

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

No branches or pull requests

2 participants