From 45273883c0bb79a2a4f507791f052360df01d9e2 Mon Sep 17 00:00:00 2001 From: Param Arora <68808783+par4m@users.noreply.github.com> Date: Thu, 24 Apr 2025 19:09:51 +0530 Subject: [PATCH 1/2] Update contributing.md - Use a more standard way of creating virtual environment - Ensure latest version of rust --- docs/docs/about/contributing.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index a366c68c0..417ff802c 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -24,15 +24,17 @@ We tag issues with the ["good first issue"](https://github.com/cocoindex-io/coco Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. - Install Rust toolchain: [docs](https://rust-lang.org/tools/install) + + Run `rustup update` to ensure you're on the latest version. -- (Optional) Setup Python virtual environment: +- (Recommended) Setup Python virtual environment: ```bash - virtualenv --python=$(which python3.12) .venv + python3 -m venv .venv ``` Activate the virtual environment, before any installings / buildings / runnings: ```bash - . .venv/bin/activate + source .venv/bin/activate ``` - Install maturin: From dd93e99b9c8c2cf604942640f42b0e7438c2de04 Mon Sep 17 00:00:00 2001 From: Param Arora <68808783+par4m@users.noreply.github.com> Date: Thu, 24 Apr 2025 21:48:34 +0530 Subject: [PATCH 2/2] Update contributing.md --- docs/docs/about/contributing.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 417ff802c..82bad46db 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -23,9 +23,16 @@ We tag issues with the ["good first issue"](https://github.com/cocoindex-io/coco ## Start hacking! Setting Up Development Environment Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. -- Install Rust toolchain: [docs](https://rust-lang.org/tools/install) +- 🦀 [Install Rust](https://rust-lang.org/tools/install) - Run `rustup update` to ensure you're on the latest version. + If you don't have Rust installed, run + ```bash + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` + Already have Rust? Make sure it's up to date + ```bash + rustup update + ``` - (Recommended) Setup Python virtual environment: ```bash @@ -34,7 +41,7 @@ Following the steps below to get cocoindex build on latest codebase locally - if Activate the virtual environment, before any installings / buildings / runnings: ```bash - source .venv/bin/activate + . .venv/bin/activate ``` - Install maturin: