So you want to help develop Ranty. Great!
Here's a brief overview of how you can contribute:
If you find something in Ranty that isn't behaving correctly, please tell us!
Bugs should be reported through the issue tracker. Please search the issues beforehand to see if your bug has already been reported. Even if your bug is already reported, please feel free to add to the discussion and provide any additional insight.
A bug report should provide a detailed description of the following:
- Your execution environment (OS, architecture, any wrapper library in use, etc.)
- Compiler info as applicable (Rust version, build profiles, etc.)
- Steps to reproduce the bug
- The expected and actual behaviors
Your ideas for how to improve Ranty are always welcome. As with bugs, feature requests are submitted via the issue tracker.
If you'd like to tackle a bug yourself you can submit a pull request for review.
Include tests for user-visible changes and update the relevant documentation in docs/ when behavior changes.