From c06af4d6d094d297a9ef3699442672ef846e6721 Mon Sep 17 00:00:00 2001 From: Rob Date: Thu, 4 Dec 2025 23:58:16 -0500 Subject: [PATCH] docs: update CONTRIBUTING --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96a539c1ce..29fb024e56 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,10 +57,42 @@ opam switch create 5.3.0 opam install . --deps-only --with-test --with-dev-setup -y ``` +> [!TIP] +> If you have +> +> ```sh +> $ git config --global core.fsmonitor +> true +> ``` +> +> and get an error when running the `opam install` command +> +> ```sh +> #=== ERROR while compiling flow_parser.0.267.0 ================================# +> Copying sockets (rescript/_opam/.opam-switch/sources/flow_parser/.git/fsmonitor--daemon.ipc) is unsupported +> ``` +> +> Run this: +> +> ```sh +> cd _opam/.opam-switch/sources/flow_parser \ +> && git config core.fsmonitor false \ +> && rm -f .git/fsmonitor--daemon.ipc +> ``` + #### npm install Run `yarn install`. This will install the npm dependencies required for the build scripts. +#### rustup install + +[Rewatch](./rewatch/) is built with rust. Make sure you have [rustup](https://rustup.rs/) installed to manage rust versions. + +```sh +rustup toolchain install 1.91 +rustup override set 1.91 +``` + ### B. Devcontainer As an alternative to the manual installation, the repository provides a [development container](https://containers.dev/) definition that can be used with [VS Code's Remote Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). Use this to get a stable development environment without having to install anything locally other than VS Code and Docker.