Skip to content

Commit b35fba3

Browse files
seanGammagesean-gammage-omniopenhands-agent
authored
Update contribution document (#327)
* Add insturctions for developing the application with containers * Update dev container instructions to use uv instead of poetry - Replace poetry/pip references with uv in the 'Without Dev Containers' section - Fix typos: 'accross' -> 'across', 'IDE's' -> 'IDEs', 'build' -> 'built', 'less' -> 'fewer' - Improve instructions for other IDEs to reference Dev Containers documentation - Make dependency installation consistent with existing uv workflow Co-authored-by: openhands <[email protected]> --------- Co-authored-by: Sean Gammage <[email protected]> Co-authored-by: openhands <[email protected]>
1 parent abd4485 commit b35fba3

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/pages/contribution/contribution.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,29 @@ write better code faster. Here are some extensions that you might want to instal
147147
- Ruff: For formatting your code.
148148
- MDX: For the documentation website under `docs` folder.
149149
- Even Better TOML: For editing aact workflow files.
150+
151+
## Using Dev Containers for development
152+
You can use dev containers to make development consistent across environments. It can be used with VS Code (preferred), other IDEs, or skip containers entirely. It is recommended to use VS Code as it is what Dev Containers was built for. Keeping a consistent IDE choice amongst developers also helps ensure we face fewer challenges.
153+
154+
### Using VS Code (Recommended)
155+
1. Install VS Code
156+
1. Install the Dev Containers extension for VS Code
157+
1. Open the sotopia folder in VS Code
158+
1. When prompted, select "Reopen in Container."
159+
160+
VS Code will build the container using the `.devcontainer` folder and open the workspace with all dependencies installed. From there, you can now run and test the project inside the container.
161+
162+
### Other IDEs or Editors
163+
Without VS Code, you will need to use basic Docker configurations.
164+
1. Please refer to [Dev Containers](https://containers.dev/supporting#editors) to see how to set up Dev Containers in other editors
165+
1. Alternatively, you can use the Docker setup directly if your editor supports it
166+
167+
### Without Dev Containers
168+
If you do not want to use containers, you can run everything directly on your machine.
169+
1. You'll need to ensure you have Python 3.10+ and install uv using `pip install uv`
170+
1. You'll need `uv` to install the project dependencies.
171+
1. Install all dependencies using uv:
172+
```
173+
uv sync --all-extras
174+
```
175+
1. From there you can run the application and tests using uv commands

0 commit comments

Comments
 (0)