Contributing to LocustDB
Thank you for your interest in contributing to LocustDB! Good places to start are this blog post, the README.md and the issue tracker. I can also recommend this blogpost, which describes a general strategy for making changes to a codebase you've never worked with before.
If you have any question about LocustDB, feel free to ask on gitter.
Working on issues
If you're looking for somewhere to start, check out the good first issue tag.
Feel free to ask for guidelines on how to tackle a problem on gitter or open a new new issue. This is especially important if you want to add new features to LocustDB or make large changes to the already existing code base. LocustDB's core developers will do their best to provide help.
Various issues have a corresponding TODO(#ISSUE_NUMBER) in the relevant section of the code.
If you start working on an already-filed issue, post a comment on this issue to let people know that somebody is working it. Feel free to ask for comments if you are unsure about the solution you would like to submit.
We use the "fork and pull" model described here, where contributors push changes to their personal fork and create pull requests to bring those changes into the source repository.
Your basic steps to get going:
- Fork LocustDB and create a branch from master for the issue you are working on.
- Please adhere to the code style that you see around the location you are working on.
- Commit as you go.
- Include tests that cover all non-trivial code. Usually the easiest way of doing that is to add a new integration test to
- If you are adding a performance optimisation, make sure there is a benchmark case in
benches/basic.rsthat covers the optimisation.
- Make sure
cargo testpasses and the bencharks can still be compiled (
cargo check --bench basic). Running clippy and rustfmt is encouraged, but the existing code is not currently compliant.
- Push your commits to GitHub and create a pull request against LocustDB's