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.

Sign up for GitHub

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

Add documentation for devcontainer setup #1268

Closed
wants to merge 1 commit into from
Closed

Add documentation for devcontainer setup #1268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ The `dev-env` script will add the `scripts` folder to your `$PATH` for the curre
shell, so in the following documentation, if you see `scripts/foo`, you're welcome
to call `foo` directly.

### Development Container

You can also use our development container setup. In VSCode, select
`Dev Containers: Reopen in Container`. This will create a container with all necessary
dependencies. Although it automatically executes `source ./dev-env` on startup, you still
need to call `source ./dev-env` in any new terminal to set the necessary environment
variables.

## Instructions for contribution

### Environment variables
Expand Down
Loading