We welcome contributions and want to make contributing to this project as easy and transparent as possible. A background in compilers and static analysis will be very useful for contributing to the main code base, but there are ample opportunities for other contributions as well. Test cases and motivating examples are particularly welcome.
Every pull request should have a description that motivates it and should have tests that cover all of the source lines touched and added by the request. No pull request will be merged unless all tests are passing.
A TODO comment should include the number of an issue that describes the outstanding work in greater detail.
All APIs should be documented in the code and all public methods and functions should have explicit assertion statements to document and enforce any preconditions that they depend on.
A pull request that is a work in progress that has been published to get help and feedback from the community should be tagged with WIP.
The person approving a pull request will also merge it into main.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the Contributor License Agreement ("CLA").
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
We use the Rust style guide
By contributing to Mirai, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.