Skip to content

Commit

Permalink
docs: add dev container docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrgrain committed Oct 17, 2022
1 parent 48df327 commit c9d21da
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ This document describes how to set up a development environment and submit your
let us know if it's not up-to-date (even better, submit a PR with your corrections ;-)).

- [Getting Started](#getting-started)
- [Local setup](#setup)
- [Dev Container](#dev-container)
- [Pull Requests](#pull-requests)
- [Step 1: Find something to work on](#step-1-find-something-to-work-on)
- [Step 2: Design (optional)](#step-2-design)
Expand All @@ -23,7 +25,7 @@ let us know if it's not up-to-date (even better, submit a PR with your correcti
- [Breaking Changes](#breaking-changes)
- [Documentation](#documentation)
- [Rosetta](#rosetta)
- [Tools](#tools)
- [Tools](#tools-advanced)
- [Linters](#linters)
- [cfn2ts](#cfn2ts)
- [scripts/foreach.sh](#scriptsforeachsh)
Expand Down Expand Up @@ -147,7 +149,14 @@ docker$ exit

The `dist/` folder within each module contains the packaged up language artifacts.

## Gitpod (Alternative)
### Dev Container

The AWS CDK provides a VS Code Dev Container with all dependencies pre-installed.
Please follow the [setup instructions](https://code.visualstudio.com/docs/remote/containers-tutorial) to configure VS Code.

With VS Code setup, you will be prompted to open the `aws-cdk` repo in a Dev Container, or you can choos "Dev Containers: Reopen in Container" from the VS Code command palette.

### Gitpod (Alternative)

You may also set up your local development environment using [Gitpod](http://gitpod.io) -
a service that allows you to spin up an in-browser Visual Studio Code-compatible editor,
Expand Down

0 comments on commit c9d21da

Please sign in to comment.