Point to the guide's contributing section instead of CONTRIBUTING.md

This commit is contained in:
Nick Fitzgerald 2018-06-19 11:49:34 -07:00
parent 4cf301985c
commit 4d3f1c63a2
2 changed files with 5 additions and 40 deletions

View File

@ -1,40 +1,4 @@
# Contributing
This document contains instructions on how to get this project up and running.
For more information on the architecture, design, and goals of this project
please checkout [`DESIGN.md`](DESIGN.md).
## Prerequisites
1. Rust Nightly. [Install Rust]. Once Rust is installed, run
```
rustup default nightly
```
[install Rust]: https://www.rust-lang.org/en-US/install.html
2. The tests for this project use Node. Make sure you have node >= 8 installed,
as that is when WebAssembly support was introduced. [Install Node].
[Install Node]: https://nodejs.org/en/
3. The tests for this project also use yarn, a package manager for Node. To install yarn, run:
```
npm install yarn -g
```
... or follow other platform-specific instructions [here](https://yarnpkg.com/en/docs/install).
Once `yarn` is installed, run it in the top level directory:
```
yarn
```
Finally, you can run the tests with `cargo`:
```
cargo test
```
See the ["Contributing" section of the `wasm-bindgen`
guide](https://rustwasm.github.io/wasm-bindgen/contributing.html).

View File

@ -69,10 +69,11 @@ at your option.
## Contribution
[See `CONTRIBUTING.md` for hacking!][contributing]
**[See the "Contributing" section of the guide for information on
hacking on `wasm-bindgen`!][contributing]**
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this project by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.
[contributing]: (https://github.com/rustwasm/wasm-bindgen/blob/master/CONTRIBUTING.md)
[contributing]: https://rustwasm.github.io/wasm-bindgen/contributing.html