Skip to content

Update contributing + gitignore #5464

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
merged 1 commit into from
Jun 24, 2022
Merged

Update contributing + gitignore #5464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,7 @@ themes
.vscode/settings.json
*.output # yacc output
jscomp/ml/parser.output
jscomp/ml/lexer.ml
jscomp/ml/lexer.ml

# opam local switch is stored in `_opam` folder
_opam
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ opam install dune
opam install ocaml-lsp-server

# Any recent OCaml version works as a development compiler
opam switch create 4.12.1
opam switch create 4.14.0 # can also create local switch with opam switch create . 4.14.0

# We use NodeJS to run our test suites and other utilities.
npm install
Expand All @@ -52,7 +52,7 @@ git submodule update

## Configure and Build the Compiler (`ninja` workflow)

> Note: These instructions allow you to do full builds of the project. In case you only want to build the project for development purposes, you can use the `dune` workflow.
> Note: These instructions allow you to do full builds of the project. In case you only want to build the project for development purposes, you can use the `dune` workflow, but you will still need to run the first step: `./scripts/ninja.js config`.

The ReScript project is built with a vendored version of `ninja`. It requires build files to correctly detect, compile and link all the OCaml files within our project. The build files are generated and managed by a NodeJS script (`./scripts/ninja.js`).

Expand Down