Skip to content

conventional-commits-rs/conventional-commits-formatter

Repository files navigation

zerotask-rust-lib-template

docs_master_badge

A GitHub template for Rust libraries.

Features

  • 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 fmt to ensure uniform source code formatting.
      • cargo clippy to use more idiomic Rust code, optimize code as well as prevent hard to spot bugs.
      • cargo check to ensure that the library compiles properly.
      • cargo test to 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-pages branch.
  • MSRV (Minimal supported Rust version)
    • Kept in sync with the latest available Rust version on Ubuntu.
  • Opinioded rustfmt configuration file.
  • Misc
    • .editorconfig file for code-unrelated files.
      • Ensures proper formatting for workflow files and other configuration files.

Current Properties

  • MSRV: 1.41.0

License

Licensed under either of

at your option.

Contribution

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.

About

No description or website provided.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages