External contributors are encouraged to submit issues and pull requests to this repository. That being said, not all issues will be addressed nor pull requests merged (even if well-intentioned).
The QMDB Library provides reliable and high-performance verifiable database and contributions that do not advance these goals may not be accepted. This could include (but is not limited to) replacing code with external dependencies, implementing optional functionality, and/or introducing algorithms that substantially increase complexity to provide marginal performance improvements. On the other hand, adding more tests and benchmarks is almost always welcome!
This repository uses the default cargo and clippy formatting rules for .rs files, treating warnings as errors. To check linting, run:
cargo clippy --all-targets --all-features -- -D warnings
cargo fmt --all -- --checkTo fix linting automatically, run:
cargo fmt --allReleases are automatically published to cargo by GitHub Actions whenever a version update is merged into the main branch.
To increment the patch version of all crates (and update the corresponding minimum required version in workspace.dependencies), run:
./scripts/bump_versions.shYou agree that any work submitted to this repository shall be dual-licensed under the included Apache 2.0 and MIT licenses, without any additional terms or conditions. Additionally, you agree to release your copyright interest in said work to the public domain, such that anyone is free to use, modify, and distribute your contributions without restriction.
Looking to discuss a potential contribution or get feedback? Reach out on GitHub Discussions!