// SPDX-FileCopyrightText: 2022 Shun Sakai
//
// SPDX-License-Identifier: Apache-2.0 OR MIT
= Contribution Guide
:git-flow: https://nvie.com/posts/a-successful-git-branching-model/[git-flow]
:commit-messages-guide: https://github.com/RomuloOliveira/commit-messages-guide[Commit messages guide]
:just: https://github.com/casey/just[just]
== Branching model
The branching model of this project is based on the {git-flow}.
== Style guides
=== Commit message
Please see the {commit-messages-guide}.
== Development
=== Useful development tools
The {just} command runner can be used. Run `just --list` for more details.
.Run tests
[source,shell]
----
just test
----
.Run the formatter
[source,shell]
----
just fmt
----
.Run the linter
[source,shell]
----
just lint
----