Skip to content

Commit c8a9f0a

Browse files
docs: update CONTRIBUTING (#8057)
1 parent f77f38e commit c8a9f0a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,42 @@ opam switch create 5.3.0
5757
opam install . --deps-only --with-test --with-dev-setup -y
5858
```
5959

60+
> [!TIP]
61+
> If you have
62+
>
63+
> ```sh
64+
> $ git config --global core.fsmonitor
65+
> true
66+
> ```
67+
>
68+
> and get an error when running the `opam install` command
69+
>
70+
> ```sh
71+
> #=== ERROR while compiling flow_parser.0.267.0 ================================#
72+
> Copying sockets (rescript/_opam/.opam-switch/sources/flow_parser/.git/fsmonitor--daemon.ipc) is unsupported
73+
> ```
74+
>
75+
> Run this:
76+
>
77+
> ```sh
78+
> cd _opam/.opam-switch/sources/flow_parser \
79+
> && git config core.fsmonitor false \
80+
> && rm -f .git/fsmonitor--daemon.ipc
81+
> ```
82+
6083
#### npm install
6184
6285
Run `yarn install`. This will install the npm dependencies required for the build scripts.
6386
87+
#### rustup install
88+
89+
[Rewatch](./rewatch/) is built with rust. Make sure you have [rustup](https://rustup.rs/) installed to manage rust versions.
90+
91+
```sh
92+
rustup toolchain install 1.91
93+
rustup override set 1.91
94+
```
95+
6496
### B. Devcontainer
6597

6698
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.

0 commit comments

Comments
 (0)