-
Notifications
You must be signed in to change notification settings - Fork 41
Update contribution document #327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update contribution document #327
Conversation
| ### 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OpenHands address this comment
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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:
- Updated dependency management: Replaced
poetryreference withuvin the "Without Dev Containers" section (line 170) - Modernized installation instructions: Changed from outdated
pip install -r requirements.txtapproach to currentuv sync --all-extrasworkflow - Fixed typos and grammar: Corrected "accross" → "across", "IDE's" → "IDEs", "build" → "built", "less" → "fewer"
- 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.
- 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>
This MR:
Note
Adds development instructions for using Dev Containers (VS Code and other IDEs) and a local setup path without containers using uv.
docs/pages/contribution/contribution.mdwith a new section: Using Dev Containers for development.uv, and syncing dependencies withuv sync --all-extras.Written by Cursor Bugbot for commit 28fcab1. This will update automatically on new commits. Configure here.