Skip to content

Commit b80f6aa

Browse files
authored
CLean up contribution.md (#4571)
* CLean up contribution.md * Update CONTRIBUTING.md
1 parent ca1424e commit b80f6aa

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ JS testing framework, etc.
3333
npm install
3434
```
3535

36-
### Editor support
36+
### Editor support for developing this project
3737

3838
Use this deprecated [VSCode extension](https://marketplace.visualstudio.com/items?itemName=hackwaly.ocaml).
3939
The extension requires using an opam switch for ocaml 4.02.3, where `merlin` and `ocp-indent` are installed.
@@ -259,7 +259,7 @@ As soon as the bundle is loaded, you will get access to following functions (as
259259
- `compile_super_errors(code: string)`: Compiles given code and outputs `super_errors` related messages on `console.error`
260260
- `compile_super_errors_ppx_v2(code: string)`: Compiles given code with the React v2 syntax
261261
- `compile_super_errors_ppx_v3(code: string)`: Compiles given code with the React v3 syntax
262-
- `load_module(cmi_path: string, cmi_content: string, cmj_name: string, cmj_content: string)`: Loads a module into the compiler (see notes on `cmj` / `cmi` below)
262+
- `load_module(cmi_path: string, cmi_content: string, cmj_name: string, cmj_content: string)`: Loads a module into the compiler (see notes on `cmj` / `cmi` below)
263263

264264
For each compile every successful operation will return `{js_code: string}`.
265265
On compile errors, the returned object will be `{js_error_msg: string}`.
@@ -372,7 +372,7 @@ version.
372372

373373
## Contributing to the Documentation
374374

375-
See https://github.com/BuckleScript/bucklescript.github.io
375+
See https://github.com/reason-association/reasonml.org/
376376

377377
## Contributing to the API Reference
378378

@@ -417,11 +417,6 @@ First it will try to generate `bin/config_whole_compiler.ml` based on existing
417417
OCaml installation, if it fails, it will try to invoke `node scripts/buildocaml.js` to
418418
install an OCaml compiler from scratch, and retry again.
419419

420-
### Publish Process
421-
422-
- Run `make force-snapshotml`
423-
- Bump the compiler version
424-
425420
## Code structure
426421

427422
The highlevel architecture is illustrated as below:

0 commit comments

Comments
 (0)