From fab633041535f641e54b0db860744e87eec9d20a Mon Sep 17 00:00:00 2001 From: KDruzhkin Date: Wed, 29 May 2024 14:39:00 +0300 Subject: [PATCH 1/2] mention `make` and `cmake` in the guide --- docs/development/contributing/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/development/contributing/index.md b/docs/development/contributing/index.md index 2aa65ed0fa5e..00bb7ea22b93 100644 --- a/docs/development/contributing/index.md +++ b/docs/development/contributing/index.md @@ -49,6 +49,7 @@ If you run into problems, please contact us on [Discord](https://discord.gg/4UfP If you are a Windows user, the steps below might not work as expected. Try developing using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). + If this is not an option, consider using [Scoop](https://scoop.sh/) or [Chocolatey](https://chocolatey.org/) to install `make`, `cmake` and other missing tools. Under native Windows, you may have to manually copy the contents of `toolchain.toml` to `py-polars/toolchain.toml`, as Git for Windows may not correctly handle symbolic links. #### Configuring Git From b630f0fa286520cec015338a20daccecf47c799d Mon Sep 17 00:00:00 2001 From: Konstantin Druzhkin Date: Thu, 30 May 2024 17:11:57 +0300 Subject: [PATCH 2/2] suggestions from the review --- docs/development/contributing/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/development/contributing/index.md b/docs/development/contributing/index.md index 00bb7ea22b93..8563d15a3621 100644 --- a/docs/development/contributing/index.md +++ b/docs/development/contributing/index.md @@ -49,7 +49,6 @@ If you run into problems, please contact us on [Discord](https://discord.gg/4UfP If you are a Windows user, the steps below might not work as expected. Try developing using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). - If this is not an option, consider using [Scoop](https://scoop.sh/) or [Chocolatey](https://chocolatey.org/) to install `make`, `cmake` and other missing tools. Under native Windows, you may have to manually copy the contents of `toolchain.toml` to `py-polars/toolchain.toml`, as Git for Windows may not correctly handle symbolic links. #### Configuring Git @@ -88,6 +87,8 @@ You will need Python even if you intend to work on the Rust code only, as we rel 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. +This guide uses [GNU make](https://www.gnu.org/software/make/) and (indirectly) [cmake](https://cmake.org/). They should come pre-installed on your system. If you are on Windows, install them as well. + You can now check that everything works correctly by going into the `py-polars` directory and running the test suite (warning: this may be slow the first time you run it):