Skip to content

update CONTRIBUTING #8057

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
nojaf merged 1 commit into from
Dec 5, 2025
Merged

update CONTRIBUTING #8057

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
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading