How to contribute

Welcome to the contributions page! Please read through the page to start your first PR. 🚀

Steps

Here are the steps to follow for your contribution!

fork the repo under your GitHub account
work on an issue, bounty or any other form of a contribution under your fork
format your code using cargo fmt
build and test your code locally with cargo build and cargo test --all
create a pull request merging from your fork into our repo

Pull request checklist

When creating a PR, please make sure to run through the following checklist:

Add a description summarizing the PR, e.g.:
- What does it do?
- What important points should reviewers know?
- Is there something left for follow-up PRs?
- For large diffs please include a changelog in the description with a bulleted "Adds | Changes | Fixes | Removes" sections
Mention the related issue, if any, e.g. Fixes #228 or Related #1337.
Unit tests
Integration tests, if appropriate
Request reviewers. If you aren't sure, start with GH suggestions.
Update rustdoc comments with changes
Update README with changes, if appropriate
Bumped the runtime version if there are breaking changes in the runtime.

Review process

Include suggested reviewers for your PR and wait for the review.

Merge process

Don't worry about merging! We will merge once everything is good!