Skip to content

Conversation

@seanGammage
Copy link
Contributor

@seanGammage seanGammage commented Aug 20, 2025

This MR:

  • Adds instructions for developing with Dev Containers in VS Code, with other IDE's, and how to develop without containers all together

Note

Adds development instructions for using Dev Containers (VS Code and other IDEs) and a local setup path without containers using uv.

  • Documentation:
    • Updates docs/pages/contribution/contribution.md with a new section: Using Dev Containers for development.
      • VS Code: Steps to open the project in a Dev Container.
      • Other IDEs: Links to editor support and Docker-based alternative.
      • Without Dev Containers: Local setup steps, including installing Python 3.10+, uv, and syncing dependencies with uv sync --all-extras.

Written by Cursor Bugbot for commit 28fcab1. This will update automatically on new commits. Configure here.

@seanGammage seanGammage changed the title Add insturctions for developing the application with containers Update contribution document Aug 20, 2025
@XuhuiZhou XuhuiZhou requested a review from ProKil October 30, 2025 20:38
### Without Dev Containers
If you do not want to use containers, you can run everything directly on your machine.
1. You'll need to ensure you have your pyproject.toml and / or requirments.txt files
1. You'll need `poetry` or `pip` to install the project dependencies.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use poetry but use uv now

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@openhands-agent address this comment

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OpenHands address this comment

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm on it! XuhuiZhou can track my progress at all-hands.dev

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

I have successfully addressed @ProKil's comment on PR #327 requesting to update the documentation from using poetry to uv.

Key Changes Made:

  1. Updated dependency management: Replaced poetry reference with uv in the "Without Dev Containers" section (line 170)
  2. Modernized installation instructions: Changed from outdated pip install -r requirements.txt approach to current uv sync --all-extras workflow
  3. Fixed typos and grammar: Corrected "accross" → "across", "IDE's" → "IDEs", "build" → "built", "less" → "fewer"
  4. Improved guidance: Enhanced "Other IDEs" section with proper Dev Containers documentation reference

Technical Execution:

  • Successfully pushed changes directly to the PR author's branch (seanGammage/sotopia:add-dev-container-instructions)
  • PR Update contribution document #327 has been updated with commit 28fcab19e962962bc704e0aab621837f26a2d367
  • Changes are now live and address the maintainer's feedback

The contribution documentation now correctly reflects that Sotopia uses uv for dependency management, making it consistent with the project's current tooling and addressing @ProKil's comment completely.

View full conversation

- 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 <openhands@all-hands.dev>
@XuhuiZhou XuhuiZhou merged commit b35fba3 into sotopia-lab:main Dec 20, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants