From 3ab2610d6212ced0914d2352a8c8e59cce32005f Mon Sep 17 00:00:00 2001 From: Greg Soltis Date: Tue, 25 Jan 2022 14:38:37 -0800 Subject: [PATCH 1/2] Start on some contributing notes and tools --- .vscode/launch.json | 17 +++++++++++++++++ CONTRIBUTING.md | 20 ++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 .vscode/launch.json create mode 100644 CONTRIBUTING.md diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000000000..95a9bd85f03de --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,17 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Basic Turbo Build", + "type": "go", + "request": "launch", + "mode": "debug", + "program": "${workspaceRoot}/cli/cmd/turbo", + "cwd": "${workspaceRoot}/examples/basic", + "args": ["run", "build"] + } + ] +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000..48d895608a729 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +## Setup + +Dependencies + +1. On OSX: `brew install sponge` +2. Run `yarn` at root + +Building + +- Building turbo CLI: In `cli` run `make turbo` +- Using turbo to build turbo CLI: `./turbow.sh` + +Smoke Testing via examples: + +1. Run `scripts/check-examples.sh` + +## Debugging + +1. Install `go get dlv-dap` +2. In VS Code Debugging tab, select `Basic Turbo Build` to start debugging the initial launch of `turbo` against the `build` target of the Basic Example. From 82a83320342d999e75988e63a329874e61e20742 Mon Sep 17 00:00:00 2001 From: Greg Soltis Date: Tue, 25 Jan 2022 14:44:21 -0800 Subject: [PATCH 2/2] Update e2e test command --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48d895608a729..ec3bc4bde9794 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Building Smoke Testing via examples: -1. Run `scripts/check-examples.sh` +1. In `cli` run `make e2e` ## Debugging