Mosaic Templates Changelog
The Mosaic Templates changelog is carefully maintained to ensure every feature, addition, and bugfix is mentioned.
Changelogs are posted in the #monitoring-mosaic Slack channel.
Guidelines / Instructions
How to Add a Changelog Entry
Changelog entries are automatically generated from the commits between the last release and the new release. We determine the changelog line by the merge commit.
To ensure your changes are mentioned in the changelog, make sure your merge request title starts with a change identifier.
Optional Ticket Number
In some cases, you might find a bug that is easily resolved without a ticket. In that case, the ticket number in the braces can be left out.
Features
Change Identifier: feat
Merge requests that start with feat will be marked as a Feature.
feat(CS-1234): Add new order component to Product Detail Page.
Bugfixes
Change Identifier: fix
Merge requests that start with fix will be marked as a Bugfix.
fix(CS-1012): Fix an issue where a product cannot be bought when using tags.
Other Issues
Change Identifier: chore
Merge requests that start with chore will be marked as Maintenance.
chore(CS-5814): Update version of <package> for better browser support.
Examples
The Mosaic Templates Changelog consists of three groups: bugfixes, features, and maintenance.
Every group has n number of lines as changes, which have the following structure:
**\<ticket number?\>:** \<A description of the change\> ([\<A link to the commit\>](#))
✨ Feature
- CAR-1582: Team widget improvements (e4555bc)
🐛 Bugfix
- 1616: Fix show the right hover image and fix JS error to show all product images (9ab2a1e)
- CAR-1584: Add party search bugfix (643ca6a)
- CAR-1603: Show delivery method description and position it correctly (258fd1f)
- CAR-1616: Fix show the right hover image and fix JS error to show all product images (2fe9f49)
- Tag custom_identifier not giving correct class in badges (4c686ba)
🛠️ Maintenance
- CAR-1620: Display description next to checkbox if filled in client (0967731)