From 4cf301985c1763025bfa1d93fbfe059f8811df49 Mon Sep 17 00:00:00 2001 From: Nick Fitzgerald Date: Tue, 19 Jun 2018 11:39:38 -0700 Subject: [PATCH] guide: Add a contributing section and move DESIGN.md under it Also adds a team section where we enumerate the folks on the `wasm-bindgen` team and who can review pull requests --- guide/src/SUMMARY.md | 6 +++++ guide/src/contributing.md | 43 ++++++++++++++++++++++++++++++++ DESIGN.md => guide/src/design.md | 0 guide/src/introduction.md | 2 +- guide/src/team.md | 30 ++++++++++++++++++++++ 5 files changed, 80 insertions(+), 1 deletion(-) create mode 100644 guide/src/contributing.md rename DESIGN.md => guide/src/design.md (100%) create mode 100644 guide/src/team.md diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index f852af407..ab0a23eff 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -10,3 +10,9 @@ - [Closures](./closures.md) - [Feature Reference](./feature-reference.md) - [CLI Reference](./cli-reference.md) + +-------------------------------------------------------------------------------- + +- [Contributing](./contributing.md) + - [Design](./design.md) + - [Team](./team.md) diff --git a/guide/src/contributing.md b/guide/src/contributing.md new file mode 100644 index 000000000..8804e4c6d --- /dev/null +++ b/guide/src/contributing.md @@ -0,0 +1,43 @@ +# Contributing to `wasm-bindgen` + +This section contains instructions on how to get this project up and running for +development. + +## Prerequisites + +1. Rust Nightly. [Install Rust]. Once Rust is installed, run + + ```shell + 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: + + ```shell + npm install -g yarn + ``` + + or follow other platform-specific instructions + [here](https://yarnpkg.com/en/docs/install). + + Once `yarn` is installed, run it in the top level directory: + + ```shell + yarn + ``` + +## Running Tests + +Finally, you can run the tests with `cargo`: + +```shell +cargo test +``` diff --git a/DESIGN.md b/guide/src/design.md similarity index 100% rename from DESIGN.md rename to guide/src/design.md diff --git a/guide/src/introduction.md b/guide/src/introduction.md index 163ccff58..e1cf5366c 100644 --- a/guide/src/introduction.md +++ b/guide/src/introduction.md @@ -28,7 +28,7 @@ welcome! If you're curious about the design plus even more information about what this crate can do, check out the [design doc]. [host]: https://github.com/WebAssembly/host-bindings -[design doc]: https://github.com/rustwasm/wasm-bindgen/blob/master/DESIGN.md +[design doc]: https://rustwasm.github.io/wasm-bindgen/design.html [dom-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/dom [console-log]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/console_log [perf-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/performance diff --git a/guide/src/team.md b/guide/src/team.md new file mode 100644 index 000000000..261be7f26 --- /dev/null +++ b/guide/src/team.md @@ -0,0 +1,30 @@ +# Team + +`wasm-bindgen` follows the [`rustwasm` organization's governance described +here][governance]: + +* All pull requests (including those made by a team member) must be approved by + at least one other team member. + +* Larger, more nuanced decisions about design, architecture, breaking changes, + trade offs, etc are made by team consensus. + +[governance]: https://github.com/rustwasm/team/blob/master/GOVERNANCE.md#repositories + +## Members + + + +| [![](https://github.com/alexcrichton.png?size=117)][alexcrichton] | [![](https://github.com/fitzgen.png?size=117)][fitzgen] | [![](https://github.com/spastorino.png?size=117)][spastorino] | [![](https://github.com/ohanar.png?size=117)][ohanar] | +|:---:|:---:|:---:|:---:| +| [`alexcrichton`][alexcrichton] | [`fitzgen`][fitzgen] | [`spastorino`][spastorino] | [`ohanar`][ohanar] | + +[alexcrichton]: https://github.com/alexcrichton +[fitzgen]: https://github.com/fitzgen +[spastorino]: https://github.com/spastorino +[ohanar]: https://github.com/ohanar