From 7880433a884e1c97ebf07d504ca402dcb3c6885c Mon Sep 17 00:00:00 2001
From: Camila Alvarez <cam.alvarez.i@gmail.com>
Date: Fri, 4 Apr 2025 23:48:37 -0300
Subject: [PATCH] docs(contributions): add suggested commit format

The contributions guidelines are updated to include a suggested format
based on the Conventional Commits specification.

closes #158

Signed-off-by: Camila Alvarez <cam.alvarez.i@gmail.com>
---
 CONTRIBUTING.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8868d5e..143c394 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,3 +33,28 @@ Just append `poe check` to your pre-commit file
 ```shell
 echo "poe check" >> .git/hooks/pre-commit
 ```
+
+### **Suggested commit format**
+
+We recommend following the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification), which has the following format:
+
+```shell
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types usually are:
+
+1. **fix**: meaning the commit patches a bug in the codebase.
+2. **feat**: the commit introduces a new feature to the codebase.
+3. **feat!** or **fix!**: the commit introduces a breaking API change.
+4. Other types are allowed, for example: **build**, **cli**, **test**, **docs**.
+
+When a commit introduces a breaking change in the API it is recommended to add a **BREAKING CHANGE:** footer.
+
+To provide contextual information an scope may be provided alongside the type. This needs to be contained within parenthesis, for example, `feat(parser): add ability to parse arrays`.
+
+You can find more details on the Conventional Commits specification site.