# Contributing

Please stick to the following recommendations when making contributions to this repo.

## General

- Each commit should be logically self-contained and shall "compile" without warnings or errors
- Please split pure refactoring or formatting changes from features


## Commit Message Format

A commit message consists of the header line and a bunch of additional lines explaining the changes.

The header line shall use the following base format:

```
topic: Short description
```

If the commit is a pure refactoring or code-formatting change, it shall have the prefix `[TIDY]` and bugfixes shall have the prefix `[FIX]`.

Examples:

- `[TIDY] CI: Move common parts to own job`
- `Style: Make navbar sticky`

## Style guide
We use stylelint to lint the (s)css, please run before you commit
```shell
(p)npm lint-fix
```
### Who to setup
We would recommend using pnpm. [Install Guide](https://pnpm.io/installation)
```shell
pnpm i
``` 
You can also use npm if you want
```shell
npm i
```