From ef69ceaf136d338422532e113b3f1cac5f9cb2e6 Mon Sep 17 00:00:00 2001
From: Kevin Trogant <kevin@trogant.de>
Date: Fri, 19 Jul 2024 12:56:37 +0200
Subject: [PATCH] doc: Document commit message format

---
 docs/COMMITS.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 docs/COMMITS.md

diff --git a/docs/COMMITS.md b/docs/COMMITS.md
new file mode 100644
index 0000000..0f42b77
--- /dev/null
+++ b/docs/COMMITS.md
@@ -0,0 +1,29 @@
+## About commit messages
+
+Commit messages should follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/)
+ 
+The format is: 
+```
+<type>[(optional scope)]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+The type is one of:
+- **fix**: Commit fixes a bug
+- **feat**: Commit introduces a new feature
+- **refactor**: Commit refactors code
+- **perf**: Commit optimizes performance
+- **doc**: Commit changes or adds documentation
+
+A scope may be appended to the type, for example:
+`feat(renderer): Implement the good lights`
+
+If a commit introduces a breaking API change, a exclamation point (!) is added after the type:
+`feat(renderer)!: New render view api`
+
+Optionally, a breaking change may contain a "BREAKING CHANGE: <description>" footer,
+that explains the change.
+