Contributing to Gotham
Please take a moment to review this document to make the contribution process easy and effective for everyone involved.
- Format your contribution with rustfmt version 0.9 or later.
- Consider using clippy.
- Document your contribution per the Rust documentation guidelines.
Provide tests that prove the functionality you're contributing is correct.
Ensure your contribution is free of all warnings and errors during compilation and testing. Gotham targets higher levels of warnings than you may have seen in other projects to maintain quality.
The core team appreciates pull requests that fix bugs, make improvements or add new features. These are one of the main points of collaboration for the Gotham project.
Pull requests should remain focused in scope and not contain unrelated commits.
Please talk to us before embarking on any significant pull request otherwise you risk spending a lot of time working on something that might not be a fit. Gitter and issues are good avenues to do this.
The Gotham project may use automated tools to verify submitted pull requests. Ensure you address any errors these tools may report.
The core team may choose to not accept your contribution. When this happens we'll explain why and where possible make suggestions for how you might be able to achieve what you set out to with your pull request.