= Contribution Guide

Thank you for your contributions!

== Feature requests and bug reports

Please submit to the https://github.com/sorairolake/rshash/issues[Issues].

== Branching model

The branching model of this project is based on the https://nvie.com/posts/a-successful-git-branching-model/[git-flow].

== Style guides

=== Commit message

Please see the https://github.com/RomuloOliveira/commit-messages-guide[Commit messages guide].

=== Coding style

The coding style of this project is based on the https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md[Rust style guide].

== Development

=== Useful development tools

.Run tests
[source, shell]
----
$ cargo test
----

.Run the code formatter
[source, shell]
----
$ cargo fmt
----

.Run the linter
[source, shell]
----
$ cargo clippy -- -D warnings
----

Also, the https://github.com/casey/just[just] command runner can be used.
Run `just --list` for more details.