> ## Documentation Index
> Fetch the complete documentation index at: https://docs.malbox.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Guidelines

> Good practices concerning contributions to Malbox

## Code conventions

We try to follow [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/about.html) and the [Rust Style Guide](https://doc.rust-lang.org/beta/style-guide/index.html).

## Git usage

We use the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) specification to format our commits.

As for our workflow, we use the following branch names:

* hotfix: `hotfix/<hotfix name>`
* feature: `feat/<feature name>`
* develop: `dev/<version number>`

<img src="https://mintcdn.com/dualhorizon/T2oza74tvZIaUCCP/images/git-workflow.png?fit=max&auto=format&n=T2oza74tvZIaUCCP&q=85&s=f61690f1a9e702f6d16ed7acd035c4bd" alt="Git workflow" width="1754" height="827" data-path="images/git-workflow.png" />

## Versioning

We use [Semantic Versioning](https://semver.org/).