A GitHub template for Rust libraries.
- Continuous Integration through GitHub Actions
- Each PR is tested by running the following commands to ensure that only working code is added to the repository:
cargo fmtto ensure uniform source code formatting.cargo clippyto use more idiomic Rust code, optimize code as well as prevent hard to spot bugs.cargo checkto ensure that the library compiles properly.cargo testto ensure that the library works as expected.
- Each push to master triggers the following:
- Generation of the newest documentation that gets pushed to the
gh-pagesbranch.
- Generation of the newest documentation that gets pushed to the
- Each PR is tested by running the following commands to ensure that only working code is added to the repository:
- MSRV (Minimal supported Rust version)
- Kept in sync with the latest available Rust version on Ubuntu.
- Opinioded
rustfmtconfiguration file. - Misc
.editorconfigfile for code-unrelated files.- Ensures proper formatting for workflow files and other configuration files.
- MSRV: 1.41.0
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.