You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+11-24
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,8 @@ Thanks for taking the time to contribute! :smile:
4
4
5
5
**Once you learn how to use Cypress, you can contribute in many ways:**
6
6
7
-
- Join the [Cypress Discord](https://on.cypress.io/discord) and answer questions. Teaching others how to use Cypress is a great way to learn more about how it works.
8
-
- Blog about Cypress. We display blogs featuring Cypress on our [Examples](https://on.cypress.io/examples) page. If you'd like your blog featured, [open a PR to add it to our docs](https://github.com/cypress-io/cypress-documentation/blob/develop/CONTRIBUTING.md#adding-examples).
7
+
- Join the [Cypress Discord](https://on.cypress.io/chat) and answer questions. Teaching others how to use Cypress is a great way to learn more about how it works.
8
+
- Blog about Cypress. We display blogs featuring Cypress on our [Examples](https://on.cypress.io/examples) page. If you'd like your blog featured, [open a PR to add it to our docs](https://github.com/cypress-io/cypress-documentation/blob/master/CONTRIBUTING.md#adding-examples).
9
9
- Write some documentation or improve our existing docs. See our [guide to contributing to our docs](https://github.com/cypress-io/cypress-documentation/blob/master/CONTRIBUTING.md).
10
10
- Give a talk about Cypress. [Contact us](mailto:support@cypress.io) ahead of time and we'll send you some swag. :shirt:
11
11
@@ -508,28 +508,13 @@ They will outline development and test procedures. When in doubt just look at th
508
508
509
509
### Branches
510
510
511
-
The repository is setup with two main (protected) branches.
511
+
The repository has one protected branch:
512
512
513
-
-`master` is the code already published, both for the main Cypress app and independent npm packages.
514
-
-`develop` is the current latest "pre-release" code. This branch is set as the default branch, and all pull requests that update the main Cypress binary should be made against this branch.
513
+
-`develop` contains the current latest "pre-release" code for the Cypress app and contains the already published code of all [standalone npm packages](./npm) Cypress maintains. This branch is set as the default branch, and all pull requests should be made against this branch.
515
514
516
-
In general, we want to publish our [standalone npm packages](./npm) continuously as new features are added. Therefore, any pull requests that only change independent `@cypress/` packages in the [`npm`](./npm) directory should be made directly off the `master` branch. We use[`semantic-release`](https://semantic-release.gitbook.io/semantic-release/) to automatically publish these packages to npm when a PR is merged directly into master.
515
+
We want to publish our [standalone npm packages](./npm) continuously as new features are added. Therefore, after any pull request that changes independent `@cypress/` packages in the [`npm`](./npm) directory will automatically publish when a PR is merged directly into `develop` and the entire build passes. We used[`semantic-release`](https://semantic-release.gitbook.io/semantic-release/) to automate the release of these packages to npm.
517
516
518
-
When updating the main Cypress app, pull requests should be made against the `develop` branch. We do not continuously deploy the Cypress binary, so `develop` contains all of the new features and fixes that are staged to go out in the next update of the main Cypress app. In addition, 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 the `develop` branch.
519
-
520
-
Essentially, if you only change files within the [`npm`](./npm) folder, then you should make a pull request against `master`. Otherwise, make it against `develop`.
521
-
522
-
All updates to `master` are automatically merged into `develop`, so `develop` always has the latest version of every package.
523
-
524
-
#### Workflow Diagrams
525
-
526
-
<!-- To edit these diagrams, visit [`./assets/DIAGRAMS`](./assets/DIAGRAMS.md) -->
527
-
<imgsrc="./assets/branching-diagram.png" />
528
-
<imgsrc="./assets/sample-workflow.png" />
529
-
530
-
### Independent Packages CI Workflow
531
-
532
-
Independent packages are automatically released when code is merged into `master` and the entire build passes.
517
+
We do not continuously deploy the Cypress binary, so `develop` contains all of the new features and fixes that are staged to go out in the next update of the main Cypress app. 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.
533
518
534
519
### Pull Requests
535
520
@@ -636,11 +621,13 @@ Below are some guidelines Cypress uses when reviewing dependency updates.
636
621
-[ ] The PR been tagged with a release in ZenHub.
637
622
-[ ] Appropriate labels have been added to the PR (for example: label `type: breaking change` if it is a breaking change)
638
623
639
-
## Deployment
624
+
## Releases
625
+
626
+
[Standalone npm packages](./npm) are deployed immediately when a PR is merged into `develop` and the entire build passes.
640
627
641
-
We will try to review and merge pull requests quickly. If you want to know our build process or build your own Cypress binary, read [the "Release Process" guide](./guides/release-process.md).
628
+
The Cypress app is typically released every two weeks. All PRs merged to `develop` will build a "pre-released" Cypress app which can be installed to verify or leverage your changes before the scheduled release. Read these instructions for [installing pre-release versions](https://docs.cypress.io/guides/references/advanced-installation#Install-pre-release-version).
642
629
643
-
Independent packages are deployed immediately upon being merged into master. You can read more [above](#independent-packages-ci-workflow).
630
+
If you want to know our build process or build your own Cypress binary, read [the "Release Process" guide](./guides/release-process.md).
0 commit comments