From 42c34f5b7634c871a091a6c23ffe3b7f748add16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Kr=C3=BCger?= Date: Thu, 29 Jun 2023 09:08:22 +0200 Subject: [PATCH] docs: add conventional commit example Closes #2415 --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 142d58f59e..b2e25e7d19 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,18 @@ This repository is a monorepo managed by Lerna. This means that all components a ## Commits -We are using [Conventional Commits](https://www.conventionalcommits.org/) to automatically versioning and creating changelog's. +We are using [Conventional Commits](https://www.conventionalcommits.org/) to automatically version the components and update their changelog's. Feel free to use a [tool of your choice](https://www.conventionalcommits.org/en/about/#tooling-for-conventional-commits) to generate these commits. +Example for a commit message +``` +feat(button): add new color blue + +Closes #ticket-1234 +``` + +For more examples, especially with BREAKING CHANGES, have a look at the [Conventional Commits Examples](https://www.conventionalcommits.org/en/v1.0.0/#examples). + ## Pattern Library via community CDN You can add any Pattern Library component via the community CDN jsdelivr. This is useful for Prototyping or experimenting or if you don't want to bother with a frontend stack. This works only native (no react support). Here an example on how to add the JS for ``: ``