You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.4 KiB
1.4 KiB
Contribution guidelines
Firstly, thank you for your interest in contributing to this project. This project is powered by the community and relies on hackers across the globe to contribute code to move this project forward.
You can see a list of contributors here
Coding guidelines
Conventions
FIXME(@<username>)
: Use this when you have made an implementation that can be improved in the future, such as improved efficiencyHACK(@<username>)
: Use this when the code you are using a temporary workaroundTODO(@<username>)
: Use this when you have kept something incomplete
Formatting
- All Rust code should be formatted using
rustfmt
Parts of the project
The project root has three main directories:
cli
: This contains code fortsh
which is the command-line client for TDBlibcore
: This contains function, structs, ... used by both thecli
and theserver
server
: This contains code for the main database server
Steps
- Fork the repository
- Make your changes and start a pull request
- Sign the CLA (if you haven't signed it already)
- One of the maintainers will review your patch and suggest changes if required
- Once your patch is approved, it will be merged into the respective branch
- Done, you're now one of the contributors 🎉
Testing locally
- Install rust (stable)
- Run
cargo build --verbose && cargo test --verbose
- That's it!