Commit d40b3139 authored by Jean-Paul's avatar Jean-Paul
Browse files

docs: added commit conventions to readme

parent 61dbf85e
......@@ -34,4 +34,17 @@ control based on our learned model
## Citing
## Commit Conventions
We use [Coventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/#summary) where commits are structured as follows:
```
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
```
`<type>` should be one of `fix:`, `feat:`, `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`
A breaking change must have `!` appended to its type. See the Conventional Commits specification for more details.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment