Skip to content

Commit

Permalink
Update contributing.md to include additional steps (#208)
Browse files Browse the repository at this point in the history
I ran into some additional necessary dependencies to install before I
could run the project. In addition, pin wit-bindgen-cli to a specific
version to avoid unnecessary diffs in generated files.
  • Loading branch information
csmarchbanks authored Dec 20, 2024
1 parent 70dacff commit d8a8c42
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
15 changes: 11 additions & 4 deletions book/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,20 @@ There are many ways to contribute:
1. Fork and clone the repository
2. Install Rust via rustup if you haven't already
3. Install [`just`][just] for running tasks
4. Build the WASM component:
4. Install [`cargo-binstall`][binstall] to install dependencies
5. Install dependencies:
```bash
(cd components && just install-deps)
```
6. Build the WASM component:
```bash
just build-component
```
5. Start building and checking the project using [bacon]:
7. Start building and checking the project using [bacon]:
```bash
just build
just watch
```
6. Run tests:
8. Run tests using [nextest]:
```bash
just test
```
Expand Down Expand Up @@ -57,4 +62,6 @@ By contributing, you agree that your contributions will be licensed under the sa

[repo]: https://github.com/grafana/augurs/
[just]: https://just.systems/man/en/
[binstall]: https://github.com/cargo-bins/cargo-binstall
[bacon]: https://dystroy.org/bacon/
[nextest]: https://nexte.st/
3 changes: 2 additions & 1 deletion components/justfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
TOOLS_DIR := "./tools"
WIT_BINDGEN_VERSION := "0.34.0"
WASI_ARCH := `uname -m`
WASI_OS := os()
WASI_VERSION := "24"
Expand All @@ -15,7 +16,7 @@ checkout-submodules:
# Install dependencies to work with WASI.
install-deps: checkout-submodules
cargo binstall -y cargo-component
cargo binstall -y wit-bindgen-cli
cargo binstall -y wit-bindgen-cli@{{WIT_BINDGEN_VERSION}}
cargo binstall -y wasm-tools
cargo binstall -y wac-cli
curl https://wasmtime.dev/install.sh -sSf | bash
Expand Down

0 comments on commit d8a8c42

Please sign in to comment.