| 1 |
# Contributing to `wasm-bindgen` |
| 2 |
|
| 3 |
This section contains instructions on how to get this project up and running for |
| 4 |
development. You may want to browse the [unpublished guide documentation] for |
| 5 |
`wasm-bindgen` as well as it may have more up-to-date information. |
| 6 |
|
| 7 |
[unpublished documentation]: https://rustwasm.github.io/wasm-bindgen/ |
| 8 |
|
| 9 |
## Prerequisites |
| 10 |
|
| 11 |
1. Rust. [Install Rust]. Once Rust is installed, run |
| 12 |
|
| 13 |
```shell |
| 14 |
rustup target add wasm32-unknown-unknown |
| 15 |
``` |
| 16 |
|
| 17 |
[install Rust]: https://www.rust-lang.org/en-US/install.html |
| 18 |
|
| 19 |
2. The tests for this project use Node. Make sure you have node >= 10 installed, |
| 20 |
as that is when WebAssembly support was introduced. [Install Node]. |
| 21 |
|
| 22 |
[Install Node]: https://nodejs.org/en/ |
| 23 |
|
| 24 |
## Code Formatting |
| 25 |
|
| 26 |
Although formatting rules are not mandatory, it is encouraged to run `cargo fmt` (`rustfmt`) with its default rules within a PR to maintain a more organized code base. If necessary, a PR with a single commit that formats the entire project is also welcome. |