Contributing Steps
Setup Development Environment
The WasmEdge is developed on Ubuntu 20.04 to take advantage of advanced LLVM features for the AOT compiler. The WasmEdge team also builds and releases statically linked WasmEdge binaries for older Linux distributions.
Our development environment requires libLLVM-12 and >=GLIBCXX_3.4.26.
If you use an operating system older than Ubuntu 20.04, please use our [special docker image] to build WasmEdge. If you are looking for the pre-built binaries for the older operating system, we also provide several pre-built binaries based on the manylinux2014 distribution.
To build WasmEdge from the source, please refer to: Build WasmEdge from source.
Contribution Workflow
Pull requests are always welcome, even if they only contain minor fixes like typos or a few lines of code. If there will be a significant effort, please document it as an issue and get a discussion going before starting to work on it.
Please submit a pull request broken down into small changes bit by bit. A pull request consisting of many features and code changes may take a lot of work to review. It is recommended to submit pull requests incrementally.
If you split your pull request into small changes, please ensure any changes that go to the main branch will not break anything. Otherwise, it can only be merged once this feature is complete.
Fork and Clone the Repository
Fork the WasmEdge repository and clone the code to your local workspace
Branches and Commits
Changes should be made on your own fork in a new branch. Pull requests should be rebased on the top of the main branch.
The WasmEdge project adopts DCO to manage all contributions. Please ensure you add your sign-off-statement through the -s or --signoff flag or the GitHub Web UI before committing the pull request message.
Develop, Build, and Test
Write code on the new branch in your fork, and build from source code with the option -DWASMEDGE_BUILD_TESTS=ON.
Then you can use these tests to verify the correctness of WasmEdge binaries.
cd <path/to/wasmedge/build_folder>
LD_LIBRARY_PATH=$(pwd)/lib/api ctest
Push and Create A Pull Request
When ready for review, push your branch to your fork repository on github.
Then visit your fork at https://github.com/$user/WasmEdge and click the Compare & Pull Request button next to your branch to create a new pull request. The pull request description should refer to all the issues it addresses. Remember to reference issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes.
Once your pull request has been opened, it will be assigned to one or more reviewers. Those reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and coding style.
Commit changes made in response to review comments to the same branch on your fork.
Reporting issues
It is a great way to contribute to WasmEdge by reporting an issue. Well-written and complete bug reports are always welcome! Please open an issue on GitHub.
Before opening any issue, please look up the existing issues to avoid submitting a duplication. If you find a match, you can "subscribe" to it to get notified of updates. If you have additional helpful information about the issue, please leave a comment.
When reporting issues, always include:
- Version of your system
- Configuration files of WasmEdge
Because the issues are open to the public, when submitting the log and configuration files, be sure to remove any sensitive information, e.g. user name, password, IP address, and company name. You can replace those parts with "REDACTED" or other strings like "****". Be sure to include the steps to reproduce the problem if applicable. It can help us understand and fix your issue faster.
Documenting
Update the documentation if you are creating or changing features. Good documentation is as necessary as the code itself. Documents are written with Markdown. See Writing on GitHub for more details.
Design new features
You can propose new designs for existing WasmEdge features. You can also design new features; please submit a proposal via the GitHub issues.
WasmEdge maintainers will review this proposal as soon as possible to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap.