Skip to content
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

docs: adding cmake requirement to contributing guide #13855

Closed
wants to merge 1 commit into from
Closed

docs: adding cmake requirement to contributing guide #13855

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/development/contributing/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,16 @@ We recommend using the latest Python version (`3.12`).
Make sure you deactivate any active virtual environments or conda environments, as the steps below will create a new virtual environment for Polars.
You will need Python even if you intend to work on the Rust code only, as we rely on the Python tests to verify all functionality.

Additionally, If you do not have [cmake](https://cmake.org) installed, it's important for compiling some of Polars' dependencies.

**For macOS:** Install `cmake` via Homebrew by running the following:

```bash
$ brew install cmake
```

**For Windows or Linux:** Download an installer from the official [cmake website](https://cmake.org/download/).

Finally, install [dprint](https://dprint.dev/install/).
This is not strictly required, but it is recommended as we use it to autoformat certain file types.

Expand Down