2019-08-16 02:58:52 +00:00
# How to Contribute to Wasmer
Thank you for your interest in contributing to Wasmer. This document outlines some recommendations on how to contribute.
## Issues & Feature Requests
2019-10-01 05:50:04 +00:00
2019-08-16 02:58:52 +00:00
Please use the issue template and provide a failing example if possible to help us recreate the issue.
## Pull Requests
2019-10-01 05:50:04 +00:00
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.
2019-08-16 02:58:52 +00:00
We recommend trying the following commands before sending a pull request to ensure code quality:
2019-10-01 05:50:04 +00:00
2019-08-16 02:58:52 +00:00
- `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`
A comprehensive CI test suite will be run by a Wasmer team member after the PR has been created.
### Common Build Issues
2019-10-01 05:50:04 +00:00
#### LLVM Dependency
2019-08-16 02:58:52 +00:00
2019-10-01 05:50:04 +00:00
`Didn't find usable system-wide LLVM`
2019-08-16 02:58:52 +00:00
2019-10-01 05:50:04 +00:00
Building Wasmer with the LLVM backend requires LLVM to be installed
2019-08-16 02:58:52 +00:00
2019-10-01 05:50:04 +00:00
#### Singlepass Nightly Only
2019-08-16 02:58:52 +00:00
`error[E0554]: #![feature] may not be used on the stable release channel`
2019-10-01 05:50:04 +00:00
Building Wasmer with the singlepass backend requires the nightly version of Rust
