From a4ab96c311e7ce8a64fb3ce0e8ccb2793cfd0dc7 Mon Sep 17 00:00:00 2001 From: Marco Falkenberg Date: Mon, 26 Feb 2024 17:20:03 +0100 Subject: [PATCH] docs: document Conventional Commits requirement --- .prettierrc.js | 3 +++ CONTRIBUTING.md | 8 ++++++++ 2 files changed, 11 insertions(+) create mode 100644 .prettierrc.js diff --git a/.prettierrc.js b/.prettierrc.js new file mode 100644 index 00000000..868b369f --- /dev/null +++ b/.prettierrc.js @@ -0,0 +1,3 @@ +import config from "./config/.prettierrc.js"; + +export default config; diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15c8dedf..869f18bb 100644 --- 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: