Skip to content

Commit 8550f41

Browse files
[mlir-tensorrt] Update CONTRIBUTING.md (#681)
This PR updates `CONTRIBUTING.md` by adding information about spinning dev container inside and outside of VS Code.
1 parent e7a64f0 commit 8550f41

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

mlir-tensorrt/CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,35 @@ described here: https://llvm.org/docs/CodingStandards.html
99

1010
Python files are formatted using the [`black` formatter](https://black.readthedocs.io/en/stable/).
1111

12+
## Development Environment
13+
14+
This project provides a pre-configured CUDA 12.5 development environment using [Dev Containers](https://containers.dev/). We offer configurations for both `ubuntu` and `rockylinux8`, located in the `.devcontainer` directory.
15+
16+
### VS Code (Recommended)
17+
1. Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
18+
2. Open the project in VS Code.
19+
3. When prompted, click "Reopen in Container" and select your preferred OS configuration.
20+
21+
VS Code will automatically build the container and connect to the development environment.
22+
23+
### Dev Containers CLI
24+
If you are not using VS Code, you can manage the environment with the [Dev Containers CLI](https://github.com/devcontainers/cli).
25+
26+
1. Install the CLI.
27+
2. Choose one of the available configurations from the `.devcontainer` directory (e.g., `cuda12.5-ubuntu-llvm17`).
28+
3. From the project root, build and start the container by running the `up` command. Replace `<config-name>` with your chosen configuration.
29+
```bash
30+
devcontainer up --workspace-folder . --config .devcontainer/<config-name>/devcontainer.json
31+
```
32+
For example:
33+
```bash
34+
devcontainer up --workspace-folder . --config .devcontainer/cuda12.5-ubuntu-llvm17/devcontainer.json
35+
```
36+
4. To open a shell inside the running container, use the `exec` command:
37+
```bash
38+
devcontainer exec --workspace-folder . --config .devcontainer/<config-name>/devcontainer.json /bin/bash
39+
```
40+
1241
## How to Submit a PR
1342

1443
- Fork the repo on GitHub

0 commit comments

Comments
 (0)