diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index ab619bfe4..470f5ea9b 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -15,9 +15,9 @@ assignees: '' A clear and concise description of what the bug is. Copy and paste the result of executing the following in your shell, so we can know the version of wasmer, Rust (if available) and architecture of your environment. ---> +--> -```bash +```sh echo "`wasmer -V` | `rustc -V` | `uname -m`" ``` @@ -33,7 +33,7 @@ For example, 4. See error If applicable, add a link to a test case (as a zip file or link to a repository we can clone). ---> +--> ### Expected behavior diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c2f0d31e..1685f4722 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,15 @@ Thank you for your interest in contributing to Wasmer. This document outlines some recommendations on how to contribute. ## Issues & Feature Requests + Please use the issue template and provide a failing example if possible to help us recreate the issue. ## Pull Requests -For large changes, please try reaching the Wasmer using Github Issues or Spectrum Chat to ensure we can accept the change once it is ready. + +For large changes, please try reaching communicating with the Wasmer maintainers via GitHub Issues or Spectrum Chat to ensure we can accept the change once it is ready. We recommend trying the following commands before sending a pull request to ensure code quality: + - `cargo fmt --all` Ensures all code is correctly formatted. - Run `cargo test` in the crates that you are modifying. - Run `cargo build --all` (nightly) or `cargo build --all --exclude wasmer-singlepass-backend` @@ -17,17 +20,14 @@ A comprehensive CI test suite will be run by a Wasmer team member after the PR h ### Common Build Issues -**LLVM Dependency** +#### LLVM Dependency -The LLVM backend requires LLVM to be installed to compile. +`Didn't find usable system-wide LLVM` -So, you may run into the following error: -``` -Didn't find usable system-wide LLVM. -No suitable version of LLVM was found system-wide or pointed -``` +Building Wasmer with the LLVM backend requires LLVM to be installed -**Singlepass Nightly Only** +#### Singlepass Nightly Only -The singlepass crate depends on nightly so you may need to add the `+nightly` cargo flag to compile this crate. `error[E0554]: #![feature] may not be used on the stable release channel` + +Building Wasmer with the singlepass backend requires the nightly version of Rust diff --git a/Makefile b/Makefile index 89210b9b0..58b85dbb1 100644 --- a/Makefile +++ b/Makefile @@ -161,7 +161,7 @@ release: # Only one backend (cranelift) release-clif: - # If you are in OS-X, you will need mingw-w64 for cross compiling to windows + # If you are on macOS, you will need mingw-w64 for cross compiling to Windows # brew install mingw-w64 cargo build --release diff --git a/docs/feature_matrix.md b/docs/feature_matrix.md index a40bd7f16..cdb6ff8ad 100644 --- a/docs/feature_matrix.md +++ b/docs/feature_matrix.md @@ -12,7 +12,6 @@ | SIMD | ⬜ | ⬜ | ✅ | | WASI | ✅ | ✅ | ✅ | - ## Language integration TODO: define a set of features that are relevant and mark them here diff --git a/install.sh b/install.sh index b937505d6..a4fc2b841 100755 --- a/install.sh +++ b/install.sh @@ -1,8 +1,8 @@ #!/bin/sh # This install script is intended to download and install the latest available -# release of the wasmer. -# Installer script inspired from: +# release of Wasmer. +# Installer script inspired by: # 1) https://raw.githubusercontent.com/golang/dep/master/install.sh # 2) https://sh.rustup.rs # 3) https://yarnpkg.com/install.sh @@ -22,7 +22,6 @@ set -e - reset="\033[0m" red="\033[31m" green="\033[32m" @@ -257,10 +256,10 @@ wasmer_install() { printf "${reset}Installing Wasmer and WAPM!$reset\n" if [ "$WASMER_INSTALL_LOG" = "$WASMER_VERBOSE" ]; then printf " -${magenta1} ww -${magenta1} wwwww -${magenta1} ww wwwwww w -${magenta1} wwwww wwwwwwwww +${magenta1} ww +${magenta1} wwwww +${magenta1} ww wwwwww w +${magenta1} wwwww wwwwwwwww ${magenta1}ww wwwwww w wwwwwww ${magenta1}wwwww wwwwwwwwww wwwww ${magenta1}wwwwww w wwwwwww wwwww @@ -269,10 +268,10 @@ ${magenta1}wwwwwwwwwwwwwww wwwww wwwww ${magenta1}wwwwwwwwwwwwwww wwwww wwwww ${magenta1}wwwwwwwwwwwwwww wwwww wwwww ${magenta1}wwwwwwwwwwwwwww wwwww wwww -${magenta1}wwwwwwwwwwwwwww wwwww -${magenta1} wwwwwwwwwwww wwww -${magenta1} wwwwwwww -${magenta1} wwww +${magenta1}wwwwwwwwwwwwwww wwwww +${magenta1} wwwwwwwwwwww wwww +${magenta1} wwwwwwww +${magenta1} wwww ${reset} " fi diff --git a/integration_tests/cowsay/README.md b/integration_tests/cowsay/README.md index f44e6e680..660e457e7 100644 --- a/integration_tests/cowsay/README.md +++ b/integration_tests/cowsay/README.md @@ -1,9 +1,8 @@ # `cowsay` integration test - This starts Wasmer with the Cowsay WASI Wasm file. The test makes assertions on the output of Wasmer. Run test with: -```bash +```sh ./integration_tests/cowsay/test.sh ``` diff --git a/lib/clif-backend/README.md b/lib/clif-backend/README.md index 7cb3023bf..9c82c761d 100644 --- a/lib/clif-backend/README.md +++ b/lib/clif-backend/README.md @@ -36,7 +36,7 @@ This crate represents the Cranelift backend integration for Wasmer. If you are using the `wasmer` CLI, you can specify the backend with: -```bash +```sh wasmer run program.wasm --backend=cranelift ``` diff --git a/lib/llvm-backend/README.md b/lib/llvm-backend/README.md index e82396c61..584b37585 100644 --- a/lib/llvm-backend/README.md +++ b/lib/llvm-backend/README.md @@ -36,7 +36,7 @@ This crate represents the LLVM backend integration for Wasmer. If you are using the `wasmer` CLI, you can specify the backend with: -```bash +```sh wasmer run program.wasm --backend=llvm ``` diff --git a/lib/singlepass-backend/README.md b/lib/singlepass-backend/README.md index 4460dcd27..cf9ee566c 100644 --- a/lib/singlepass-backend/README.md +++ b/lib/singlepass-backend/README.md @@ -37,7 +37,7 @@ This crate represents the Singlepass backend integration for Wasmer. If you are using the `wasmer` CLI, you can specify the backend with: -```bash +```sh wasmer run program.wasm --backend=singlepass ```