Thank you for taking the opportunity to the project! Your input is greatly appreciated. Feel free to contact the maintainers if you have anymore questions after reading this.
Bugs should be reported using GitHub's issues. Upon creating a new issue, two default templates are presented to you which you can use. You can of course create your issue report without a template as well. Please make sure to report bugs related to security using the security policy instead of public issues.
Good bug reports tend to have:
- A quick summary and/or background.
- Steps to reproduce 2.a Be specific! 2.b Give sample code if you can. This should be easy to run for anyone that can compile the project.
- What you expected would happen.
- What actually happens.
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
- Fork the repository and create your branch from
master. - If you feel like the code you wrote can and should be tested, make sure to write tests for it.
- Don't forget to add documentation to whatever code you have written. This makes sure that your code is easier to understand for other developers.
- Ensure that after you have made your changes, all of the tests pass. This is automatically checked by GitHub Actions when you create the pull request.
- Check that your code follows the style guidelines of this project. This is as easy as simply running
cargo fmton the project. The style configuration is specified in rustfmt.toml.
By contributing, you agree that any contributions made will be under the same Apache 2.0 license that covers the rest of the Mirai project.