You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs-starlight/src/content/docs/03-community/01-contributing.md
+40
Original file line number
Diff line number
Diff line change
@@ -302,6 +302,46 @@ Every source file in this project should be formatted with `go fmt`. There are f
302
302
303
303
To ensure that your changes get properly formatted, please install the git pre-commit hook with `make install-pre-commit-hook`.
304
304
305
+
### Development Containers
306
+
307
+
[Development Containers](https://containers.dev/) enable you to capture an entire development environment within a container. They can specify the required binaries, languages, extensions, and settings for a project. They can even define commands to run when entering the container. The [Dev Container spec](https://containers.dev/implementors/spec/) is met by a number of [supporting tools and editors](https://containers.dev/supporting), but here we demonstrate a Visual Studio Code example for contributing to the Terragrunt project.
308
+
309
+
1. Install the [Dev Containers VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
310
+
311
+
2. Create a `.devcontainer.json` file at the project root. The example below launches a container configured with the appropriate version of Go, integrates the `golangci-lint` tool into the editor, installs the markdownlint extension with specific rules disabled (MD013 and MD024), includes Node.js and Terraform, and starts the Astro Starlight docs upon container startup.
"postCreateCommand": "cd docs-starlight && npm install && npm run dev"
340
+
}
341
+
```
342
+
343
+
3. Open the project as a VSCode workspace and, when prompted, select `Reopen in Container`. If you miss the prompt, just open the command palette and run `Dev Containers: Rebuild and Reopen in Container`.
0 commit comments