Skip to content

Update contributing.md #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
badmonster0 merged 2 commits into from
Apr 25, 2025
+12 −3
Merged

Update contributing.md #381

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4527388
Update contributing.md
par4m Apr 24, 2025
dd93e99
Update contributing.md
par4m Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/docs/about/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,20 @@ 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)

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
```

- (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:

Expand Down