From 7e680347ccd96386a54dde5b420e5e3da0b443c0 Mon Sep 17 00:00:00 2001 From: Lachlan Miller Date: Fri, 30 Jun 2023 23:49:37 +1000 Subject: [PATCH] chore: update contributing docs (#27173) Co-authored-by: Mike Plummer --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09763aa5403e..de2fc52b73f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -237,12 +237,14 @@ If there are errors building the packages, prefix the commands with `DEBUG=cypre When running `yarn start` this routes through the CLI and eventually calls `yarn dev` with the proper arguments. This enables Cypress day-to-day development to match the logic of the built binary + CLI integration. -If you want to bypass the CLI entirely, you can use the `yarn dev` task and pass arguments directly. For example, to headlessly run a project in a given folder, while trying to record to Cypress Cloud. +CLI flags can be passed to `yarn` targets to control application behavior when running locally. For example, to headlessly run a project in a given folder, while trying to record to Cypress Cloud: ```text -yarn dev --run-project /project/folder --record --key +yarn cypress:run --project /project/folder --record --key ``` +Alternatively, you can run `yarn dev` at the root of this repository to bypass the CLI. This will launch "global" mode, where you can then select a project. + #### Adding new Dependencies ⚠️ There is a [bug in yarn](https://github.com/yarnpkg/yarn/issues/7734) that may cause issues adding a new dependency to a workspace. You can avoid this by downgrading yarn to 1.19.1 (temporarily downgrade using `npx yarn@1.19.1 workspace @packages/server add my-new-dep1`).