Skip to content

Improved readme #3

@RHRolun

Description

@RHRolun

We need a well-written, developer-friendly README that clearly explains how to test OpenHands — both for contributors and new users. This should include:

✅ Overview of the testing strategy (e.g. unit tests, integration tests, e2e if applicable)

🧪 How to run the tests locally (with any environment setup or dependencies)

📦 Dependencies and tools used (e.g., pytest, tox, unittest, etc.)

🚀 CI pipeline basics – where and how tests are run automatically

🛠️ Troubleshooting tips – common test failures and how to resolve them

🧼 How to write new tests – conventions, directory structure, and examples

🗂️ Link to relevant files/scripts like test/, tox.ini, .github/workflows, etc.

This README should live in the tests/ directory (or root if we don't have one there yet) and serve as a go-to guide for keeping test quality high and onboarding new contributors smoothly.

Let's make it easy for everyone to test OpenHands confidently! 🙌

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions