docs: Update Development and CONTRIBUTING docs (OpenHands#2453)

mamoodi · Mahmoud Work · web-flow · commit b5e6ba823990 · 2024-06-16T10:45:10.000-04:00
* docs: Update Development and CONTRIBUTING docs

* Explain the PR process in simpler terms

* Fix formatting

---------

Co-authored-by: Mahmoud Work &lt;mahmoudwork@mahmouds-mini.home&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,36 +1,35 @@
 # Contributing
-
-Thanks for your interest in contributing to OpenDevin! We welcome and appreciate contributions.
-To report bugs, create a [GitHub issue](https://github.com/OpenDevin/OpenDevin/issues/new/choose).
+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](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
 
 ## Contribution Guide
 ### 1. Fork the Official Repository
-
-Fork [OpenDevin repository](https://github.com/OpenDevin/OpenDevin) into your own account.
-Clone your own forked repository into your local environment.
+Fork the [OpenDevin repository](https://github.com/OpenDevin/OpenDevin) into your own account.
+Clone your own forked repository into your local environment:
 
 ```shell
 git clone git@github.com:<YOUR-USERNAME>/OpenDevin.git
 ```
 
 ### 2. Configure Git
-
 Set the official repository as your [upstream](https://www.atlassian.com/git/tutorials/git-forks-and-upstreams) to synchronize with the latest update in the official repository.
-Add the original repository as upstream
+Add the original repository as upstream:
 
 ```shell
 cd OpenDevin
 git remote add upstream git@github.com:OpenDevin/OpenDevin.git
 ```
 
-Verify that the remote is set.
+Verify that the remote is set:
+
 ```shell
 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.
+Synchronize latest commit with official repository before coding:
 
 ```shell
 git fetch upstream
@@ -40,24 +39,32 @@ git push origin main
 ```
 
 ### 4. Create a New Branch And Open a Pull Request
-After you finish implementation, open forked repository. The source branch is your new branch, and the target branch is `OpenDevin/OpenDevin` `main` branch. Then PR should appears in [OpenDevin PRs](https://github.com/OpenDevin/OpenDevin/pulls).
-
-Then OpenDevin team will review your code.
+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](https://github.com/OpenDevin/OpenDevin/pulls).
+
+Then the OpenDevin team will review your code.
 
 ## PR Rules
-
 ### 1. Pull Request title
-
-As described in [here](https://github.com/commitizen/conventional-commit-types/blob/master/index.json), a valid PR title should begin with one of the following prefixes:
+As described [here](https://github.com/commitizen/conventional-commit-types/blob/master/index.json), a valid PR title should begin with one of the following prefixes:
 
 - `feat`: A new feature
 - `fix`: A bug fix
-- `doc`: Documentation only changes
+- `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
-- `style`: A refactoring that improves code style
 - `perf`: A code change that improves performance
 - `test`: Adding missing tests or correcting existing tests
-- `ci`: Changes to CI configuration files and scripts (example scopes: `.github`, `ci` (Buildkite))
+- `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
 
@@ -67,24 +74,21 @@ For example, a PR title could be:
 
 You may also check out previous PRs in the [PR list](https://github.com/OpenDevin/OpenDevin/pulls).
 
-As described in [here](https://github.com/OpenDevin/OpenDevin/labels), we create several labels. Every PR should be tagged with the corresponding labels.
+As described [here](https://github.com/OpenDevin/OpenDevin/labels), 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 is large and you have changed a lot, it's better to write more details.
-
+- If it contains a lot of changes, it's better to write more details.
 
-## How to begin
+## How to Begin
 Please refer to the README in each module:
 - [frontend](./frontend/README.md)
 - [agenthub](./agenthub/README.md)
 - [evaluation](./evaluation/README.md)
 - [opendevin](./opendevin/README.md)
     - [server](./opendevin/server/README.md)
-    - [mock server](./opendevin/mock/README.md)
 
 ## Tests
-Please navigate to `tests` folder to see existing test suites.
+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.
diff --git a/Development.md b/Development.md
@@ -1,8 +1,9 @@
 # Development Guide
 This guide is for people working on OpenDevin and editing the source code.
+If you wish to contribute your changes, check out the [CONTRIBUTING.md](https://github.com/OpenDevin/OpenDevin/blob/main/CONTRIBUTING.md) on how to clone and setup the project initially before moving on.
+Otherwise, you can clone the OpenDevin project directly.
 
 ## Start the server for development
-
 ### 1. Requirements
 * Linux, Mac OS, or [WSL on Windows](https://learn.microsoft.com/en-us/windows/wsl/install)
 * [Docker](https://docs.docker.com/engine/install/) (For those on MacOS, make sure to allow the default Docker socket to be used from advanced settings!)
@@ -27,42 +28,41 @@ mamba install conda-forge::poetry
 ```
 
 ### 2. Build and Setup The Environment
+Begin by building the project which includes setting up the environment and installing dependencies. This step ensures that OpenDevin is ready to run on your system:
 
-- **Build the Project:** Begin by building the project, which includes setting up the environment and installing dependencies. This step ensures that OpenDevin is ready to run smoothly on your system.
-    ```bash
-    make build
-    ```
+```bash
+make build
+```
 
 ### 3. Configuring the Language Model
-
 OpenDevin supports a diverse array of Language Models (LMs) through the powerful [litellm](https://docs.litellm.ai) library. By default, we've chosen the mighty GPT-4 from OpenAI as our go-to model, but the world is your oyster! You can unleash the potential of Anthropic's suave Claude, the enigmatic Llama, or any other LM that piques your interest.
 
-To configure the LM of your choice, follow these steps:
-
-1. **Using the Makefile: The Effortless Approach**
-   With a single command, you can have a smooth LM setup for your OpenDevin experience. Simply run:
+To configure the LM of your choice, run:
+       
    ```bash
    make setup-config
    ```
+   
    This command will prompt you to enter the LLM API key, model name, and other variables ensuring that OpenDevin is tailored to your specific needs. Note that the model name will apply only when you run headless. If you use the UI, please set the model in the UI.
-   Set `persist_sandbox` to false if you want to use clean sandbox for each task. If `persist_sandbox` is set to true, you will need to set the `ssh_password` as well.
+   Set `persist_sandbox` to false if you want to use a clean sandbox for each task. If `persist_sandbox` is set to true, you will need to set the `ssh_password` as well.
+   
+   Note: If you have previously run OpenDevin using the docker command, you may have already set some environmental variables in your terminal. The final configurations are set from highest to lowest priority:
+   Environment variables > config.toml variables > default variables
 
 **Note on Alternative Models:**
-Some alternative models may prove more challenging to tame than others. Fear not, brave adventurer! We shall soon unveil LLM-specific documentation to guide you on your quest. And if you've already mastered the art of wielding a model other than OpenAI's GPT, we encourage you to [share your setup instructions with us](https://github.com/OpenDevin/OpenDevin/issues/417).
+Some alternative models may prove more challenging to tame than others. Fear not, brave adventurer! We shall soon unveil LLM-specific documentation to guide you on your quest. 
+And if you've already mastered the art of wielding a model other than OpenAI's GPT, we encourage you to share your setup instructions with us by creating instructions and adding it [to our documentation](https://github.com/OpenDevin/OpenDevin/tree/main/docs/modules/usage/llms).
 
 For a full list of the LM providers and models available, please consult the [litellm documentation](https://docs.litellm.ai/docs/providers).
 
-There is also [documentation for running with local models using ollama](./docs/documentation/LOCAL_LLM_GUIDE.md).
-
-### 4. Run the Application
-
-- **Run the Application:** Once the setup is complete, launching OpenDevin is as simple as running a single command. This command starts both the backend and frontend servers seamlessly, allowing you to interact with OpenDevin without any hassle.
-    ```bash
-    make run
-    ```
-
-### 5. Individual Server Startup
+### 4. Running the application
+#### Option A: Run the Full Application
+Once the setup is complete, launching OpenDevin is as simple as running a single command. This command starts both the backend and frontend servers seamlessly, allowing you to interact with OpenDevin:
+```bash
+make run
+```
 
+#### Option B: Individual Server Startup
 - **Start the Backend Server:** If you prefer, you can start the backend server independently to focus on backend-related tasks or configurations.
     ```bash
     make start-backend
@@ -74,29 +74,25 @@ There is also [documentation for running with local models using ollama](./docs/
     ```
 
 ### 6. LLM Debugging
-
-If you encounter any issues with the Language Model (LM) or you're simply curious, you can inspect the actual LLM prompts and responses. To do so, export DEBUG=1 in the environment and restart the backend. OpenDevin will then log the prompts and responses in the logs/llm/CURRENT_DATE directory, allowing you to identify the causes.
+If you encounter any issues with the Language Model (LM) or you're simply curious, you can inspect the actual LLM prompts and responses. To do so, export DEBUG=1 in the environment and restart the backend.
+OpenDevin will then log the prompts and responses in the logs/llm/CURRENT_DATE directory, allowing you to identify the causes.
 
 ### 7. Help
-
-- **Get Some Help:** Need assistance or information on available targets and commands? The help command provides all the necessary guidance to ensure a smooth experience with OpenDevin.
-    ```bash
-    make help
-    ```
+Need assistance or information on available targets and commands? The help command provides all the necessary guidance to ensure a smooth experience with OpenDevin.
+```bash
+make help
+ ```
 
 ### 8. Testing
-
 #### Unit tests
 
 ```bash
 poetry run pytest ./tests/unit/test_sandbox.py
 ```
 
 #### Integration tests
-
 Please refer to [this README](./tests/integration/README.md) for details.
 
 ### 9. Add or update dependency
-
 1. Add your dependency in `pyproject.toml` or use `poetry add xxx`
 2. Update the poetry.lock file via `poetry lock --no-update`
