All contributions including bug reports, bug fixes, documentation improvements, feature enhancements, and ideas are always welcome.
Since this project is still in the early stage, there are so many things to do that I cannot write them down. However, if multiple contributors do the same work, both of them will get unhappy. So, it is helpful if you first make an issue before you start working so that the project can assign you.
When this project can grow to have a good community and continuous contributors, major themes will be settled and more descriptions will be written down.
When using other crates, we have a policy that we do not designate dependency versions too strictly.
Based on semantic versioning, for stable crates with a major version of 1 or higher, we specify dependencies using only the major version as much as possible (i.e., "1" for version "x.y.z"). Also, for unstable crates whose major version is less than 1, we specify dependencies with minor versions as much as possible (i.e., "0.y" for "0.y.z").
Of course, this is not the case if we need to be more specific in order to avoid bugs or API changes in a particular version.
See the Cargo documentation for specifying dependencies.
Rust has a formal coding style as described in Rust Style Guide. We are using the nightly version of rustfmt for formatting code in that style.
Also, Rust has an official linting tool rust-clippy. We are using the nightly version of rust-clippy.
To install those tools using rustup, you can simply run as follows:
rustup toolchain install nightly --component rustfmt clippy
To reformat and lint the code, you just need to run these simple commands:
cargo +nightly fmt --all
cargo +nightly clippy --workspace
Testing is very important. Please run tests before committing.
You can test all packages in the workspace using this simple command:
cargo test --workspace
Since passing tests needs successful building, the prerequisites for committing are now all fulfilled.
As is commonly known, Git uses the first line as a subject line. So, please use a following style if you want to set longer commit messages:
<subject line>
<BLANK LINE>
<body>
For more details, please check past commit messages. That is the shortest route.