OpenHands/CONTRIBUTING.md

Contributing

Thanks for your interest in contributing to OpenDevin! We welcome and appreciate contributions. If you are only looking to setup a development workflow, check out Development.md.

Contribution Guide

1. Fork the Official Repository

Fork the OpenDevin repository into your own account. Clone your own forked repository into your local environment:

git clone git@github.com:<YOUR-USERNAME>/OpenDevin.git

2. Configure Git

Set the official repository as your upstream to synchronize with the latest update in the official repository. Add the original repository as upstream:

cd OpenDevin
git remote add upstream git@github.com:OpenDevin/OpenDevin.git

Verify that the remote is set:

git remote -v

You should see both origin and upstream in the output.

3. Synchronize with Official Repository

Synchronize latest commit with official repository before coding:

git fetch upstream
git checkout main
git merge upstream/main
git push origin main

4. Create a New Branch And Open a Pull Request

1. Create a new branch with your changes
2. On Github, go to the page of your forked repository
3. Create a Pull Request
   • Click on Branches
   • Click on the ... beside your branch and click on New pull request
   • Set base repository to OpenDevin/OpenDevin
   • Set base to main
   • Click Create pull request

The PR should appear in OpenDevin PRs.

Then the OpenDevin team will review your code.

PR Rules

1. Pull Request title

As described here, a valid PR title should begin with one of the following prefixes:

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing tests or correcting existing tests
• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• chore: Other changes that don't modify src or test files
• revert: Reverts a previous commit

For example, a PR title could be:

• refactor: modify package path
• feat(frontend): xxxx, where (frontend) means that this PR mainly focuses on the frontend component.

You may also check out previous PRs in the PR list.

As described here, we have created several labels. Every PR should be tagged with the corresponding labels.

2. Pull Request description

• If your PR is small (such as a typo fix), you can go brief.
• If it contains a lot of changes, it's better to write more details.

How to Begin

Please refer to the README in each module:

• frontend
• agenthub
• evaluation
• opendevin
  • server

Tests

Please navigate to the tests folder to see existing test suites. At the moment, we have two kinds of tests: unit and integration. Please refer to the README for each test suite. These tests also run on CI to ensure quality of the project.