Merge pull request #19 from mittwald/docs/conventional-commits

docs: document Conventional Commits requirement
mittwald · Feb 26, 2024 · e1b0e8f · e1b0e8f
2 parents 3f028be + a4ab96c
commit e1b0e8f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,3 @@
+import config from "./config/.prettierrc.js";
+
+export default config;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,6 +9,14 @@
   corresponding template files in the `packages/generator/resources/templates`
   directory.
 
+## Use Conventional Commits
+
+Please use the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
+syntax for your commit messages. It is required because the CI automatically
+determines the version bump and generates CHANGELOG.md files based on the
+included commits when a PR is merged.
+
 ## Building locally
 
 Requirements for building the project locally: