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..ec3bc4bde9794 --- /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. In `cli` run `make e2e` + +## 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.