Update README.md

aodn · Oct 30, 2024 · 67898e8 · 67898e8
1 parent dc89545
commit 67898e8
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -85,3 +85,15 @@ The configurations for pre-commit hooks are defined in `.pre-commit-config.yaml`
 ```shell
 pre-commit run --all-files
 ```
+
+### Versioning
+
+This project uses **semantic versioning** with automated releases managed by `semantic-release`.
+
+Every code change with commits following [Conventional Commits](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) will trigger a version update and create a GitHub release.
+
+**Commit Guidelines**
+
+* `feat:` For new features
+* `fix:` For bug fixes
+* `BREAKING CHANGE:` For any breaking changes