summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorHenry Gressmann <mail@henrygressmann.de>2024-09-10 00:26:55 +0200
committerHenry Gressmann <mail@henrygressmann.de>2024-09-10 00:26:55 +0200
commit58fe7ce65d7a43bc05e0f3036fcfb15a33c50cbc (patch)
tree764fb643f03c90269c8d797aa6aed11761ad1da5 /CONTRIBUTING.md
parent34ea51ad9ccedbec3c3371104ff4240de84abdc5 (diff)
docs: update changelog/contributing
Signed-off-by: Henry Gressmann <mail@henrygressmann.de>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md24
1 files changed, 3 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e1ca837..933b19f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,29 +2,11 @@
> To improve the development experience, a number of custom commands and aliases have been added to the `.cargo/config.toml` file. These can be run using `cargo <command>`.
-- **`cargo dev [args]`**\
- e.g. `cargo dev -f check ./examples/wasm/call.wat -a i32:0`\
- Run the development version of the tinywasm-cli. This is the main command used for developing new features.\
- See [tinywasm-cli](./crates/cli) for more information.
-
-- **`cargo test-mvp`**\
+- **`cargo test-wasm-1`**\
Run the WebAssembly MVP (1.0) test suite. Be sure to cloned this repo with `--recursive` or initialize the submodules with `git submodule update --init --recursive`
-- **`cargo test-2`**\
+- **`cargo test-wasm-2`**\
Run the full WebAssembly test suite (2.0)
- **`cargo test-wast <path>`**\
- Run a single WAST test file. e.g. `cargo test-wast ./examples/wast/i32.wast`
-
-- **`cargo version-dev`**\
- Bump the version to the next dev version. This should be used after a release so test results are not overwritten. Does not create a new github release.
-
-## Workspace Commands
-
-> These commands require the [cargo-workspaces](https://crates.io/crates/cargo-workspaces) crate to be installed.
-
-- **`cargo workspaces version`**\
- Bump the version of all crates in the workspace and push changes to git. This is used for releasing new versions on github.
-
-- **`cargo workspaces publish --publish-as-is`**\
- Publish all crates in the workspace to crates.io. This should be used a new version has been released on github. After publishing, the version should be bumped to the next dev version.
+ Run a single WAST test file. e.g. `cargo test-wast ./examples/wast/i32.wast`. Useful for debugging failing test-cases.