Skip to content

Commit

Permalink
docs: add conventional commit example
Browse files Browse the repository at this point in the history
Closes #2415
  • Loading branch information
thomas-krueger-axa committed Jun 29, 2023
1 parent 111ac3e commit 42c34f5
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<axa-button></axa-button>`: `<script src="https://cdn.jsdelivr.net/npm/@axa-ch/button@latest/dist/index.js"></script>`
Expand Down

0 comments on commit 42c34f5

Please sign in to comment.