mirror of
https://github.com/rustwasm/wasm-bindgen.git
synced 2024-12-27 03:55:20 +03:00
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
This commit is contained in:
parent
feec53a73b
commit
4cf301985c
@ -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)
|
||||
|
43
guide/src/contributing.md
Normal file
43
guide/src/contributing.md
Normal file
@ -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
|
||||
```
|
@ -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
|
||||
|
30
guide/src/team.md
Normal file
30
guide/src/team.md
Normal file
@ -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
|
||||
|
||||
<style>
|
||||
img {
|
||||
max-width: 117px;
|
||||
max-height: 117px;
|
||||
}
|
||||
</style>
|
||||
|
||||
| [![](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
|
Loading…
Reference in New Issue
Block a user