Skip to content

Commit 5a818c5

Browse files
committed
Update CONTRIBUTING.md
1 parent 0d7649e commit 5a818c5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ And if you have any questions, please feel free to reach out on [Discord].
2222
If you use editors that support [VS Code-style multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces),
2323
such as VS Code, Cursor...etc., opening the editor with `sentry-ruby.code-workspace` file will provide a better development experience.
2424

25+
## Working in a devcontainer
26+
27+
If you use [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension, you can open the project with the devcontainer by running `Remote-Containers: Reopen in Container` command.
28+
29+
The devcontainer is configured with `.devcontainer/.env` file, that you need to create:
30+
31+
```bash
32+
cp .devcontainer/.env.example .devcontainer/.env
33+
```
34+
35+
This file defines which specific image and Ruby version will be used to run the code. Edit it whenever you need to use a different image or Ruby version.
36+
2537
## Contribute To Individual Gems
2638

2739
- Install the dependencies of a specific gem by running `bundle` in it's subdirectory. I.e:

0 commit comments

Comments
 (0)