diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 39 |
1 files changed, 15 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2302bef..9c713bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,12 @@ # Contributing -Thank you for considering contributing to this project! This document outlines the process for contributing to this project. For small changes or bug fixes, feel free to open a pull request directly. For larger changes, please open an issue first to discuss the proposed changes. Also, please ensure that you open up your pull request against the `next` branch and [allow maintainers of the project to edit your code](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). +Thank you for considering a contribution. For small fixes, feel free to open a pull request directly. For larger changes, please open an issue first so we can discuss the approach. Please target the `next` branch and [allow maintainers to edit your PR branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). -## 1. Clone the Repository +## Code of Conduct -Ensure you clone this repository with the `--recursive` flag to include the submodules: +This project follows the [Contributor Covenant 3.0 Code of Conduct](https://www.contributor-covenant.org/version/3/0/code_of_conduct/). -```bash -git clone --recursive https://github.com/explodingcamera/tinywasm.git -``` - -If you have already cloned the repository, you can initialize the submodules with: - -```bash -git submodule update --init --recursive -``` - -This is required to run the WebAssembly test suite. - -## 2. Set up the Development Environment +## Development This project mostly uses a pretty standard Rust setup. Some common tasks: @@ -32,14 +20,17 @@ $ cargo test # Run only the WebAssembly MVP (1.0) test suite $ cargo test-wasm-1 -# Run only the full WebAssembly test suite (2.0) +# Run only the full WebAssembly 2.0 test suite $ cargo test-wasm-2 -# Run a specific test (run without arguments to see available tests) -$ cargo test --test {test_name} +# Run only the full WebAssembly 3.0 test suite +$ cargo test-wasm-3 # Run a single WAST test file -$ cargo test-wast {path} +$ cargo test-wast ./wasm-testsuite/data/wasm-v1/{file}.wast + +# Run custom wasm tests from crates/tinywasm/tests/wasm-custom +$ cargo test-wasm-custom # Run a specific example (run without arguments to see available examples) # The wasm test files required to run the `wasm-rust` examples are not @@ -51,20 +42,20 @@ $ cargo run --example {example_name} ### Profiling -Either [samply](https://github.com/mstange/samply/) or [cargo-flamegraph](https://github.com/flamegraph-rs/flamegraph) are recommended for profiling. +Use [samply](https://github.com/mstange/samply/) for profiling. Example usage: ```bash cargo install --locked samply -cargo samply --example wasm-rust -- selfhosted +samply record -- cargo run --release --example wasm-rust -- selfhosted ``` -# Commits +## Commits This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages. For pull requests, the commit messages will be squashed so you don't need to worry about this too much. However, it is still recommended to follow this convention for consistency. -# Branches +## Branches - `main`: The main branch. This branch is used for the latest stable release. - `next`: The next branch. Development happens here. |