diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9450704..8fa26e2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,26 +9,26 @@ Before getting started, ensure that the following dependencies are installed: 1. **Go** Download and install the latest version of Go by following the [official installation guide](https://go.dev/doc/install). - 2. **Python and `sqlglot[rs]` package** - MyDuck Server depends on the `sqlglot[rs]` package, which can be installed using `pip3`. You have two options for installation: - - - **Global installation** (use with caution as it may affect system packages): - ```bash - pip3 install "sqlglot[rs]" --break-system-packages - ``` - - - **Installation inside a virtual environment** (recommended): - ```bash - mkdir -p ~/venv - python3 -m venv ~/venv/myduck - source ~/venv/myduck/bin/activate - pip3 install "sqlglot[rs]" - ``` - - Make sure to activate the virtual environment when you work on the project: - ```bash - source ~/venv/myduck/bin/activate - ``` +2. **Python and `sqlglot[rs]` package** + MyDuck Server depends on the `sqlglot[rs]` package, which can be installed using `pip3`. You have two options for installation: + + - **Global installation** (use with caution as it may affect system packages): + ```bash + pip3 install "sqlglot[rs]" --break-system-packages + ``` + + - **Installation inside a virtual environment** (recommended): + ```bash + mkdir -p ~/venv + python3 -m venv ~/venv/myduck + source ~/venv/myduck/bin/activate + pip3 install "sqlglot[rs]" + ``` + + Make sure to activate the virtual environment when you work on the project: + ```bash + source ~/venv/myduck/bin/activate + ``` ---