feat: support perf by default in changelog

Author: hfudev

README.md

@@ -297,6 +297,7 @@ Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`
         '🚨 Breaking Changes',
         '✨ New Features',
         '🐛 Bug Fixes',
+        '⚡ Performance Improvements',
         '📖 Documentation',
         '🔧 Code Refactoring',
         '🗑️ Removals',
@@ -310,6 +311,7 @@ Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`
         'Breaking Changes',
         'New Features',
         'Bug Fixes',
+        'Performance Improvements',
         'Documentation',
         'Code Refactoring',
         'Removals',
@@ -322,7 +324,7 @@ Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`
     # - Redefine which types are shown in the changelog -
     # Note: You need to list here ALL types that you want to have in the changelog - included default ones
     # Note: The order in this list doesn't matter — if you want to change the sections' order too, use with "change_type_order."
-    types_in_changelog = ["feat", "fix", "refactor", "style", "ci"]
+    types_in_changelog = ["feat", "fix", "refactor", "style", "ci", "perf"]
 
 
     # - Custom text that you can append to release notes output -

czespressif/defaults.py

@@ -30,6 +30,14 @@
         'bump': 'PATCH',
         'changelog': True,
     },
+    {
+        'type': 'perf',
+        'description': 'A code change that improves performance',
+        'heading': 'Performance Improvements',
+        'emoji': '⚡',
+        'bump': 'PATCH',
+        'changelog': True,
+    },
     {
         'type': 'docs',
         'description': 'Documentation only change',

tests/__snapshots__/test_changelog/test_changelog_cz_default_full.md

@@ -12,16 +12,14 @@
 
 ## v1.2.0 (2024-07-15)
 
-### Refactor
-
-- optimize database queries for user data retrieval
-
-## v1.2.0.rc0 (2024-06-10)
-
 ### Fix
 
 - **frontend**: correct layout issues in user profile page
 
+### Refactor
+
+- optimize database queries for user data retrieval
+
 ## v1.1.0 (2024-05-23)
 
 ### Fix

tests/__snapshots__/test_changelog/test_changelog_czespressif_full.md

@@ -7,7 +7,7 @@
 > All notable changes to this project are documented in this file.
 > This list is not exhaustive - only important changes, fixes, and new features in the code are reflected here.
 
-<div align="center">
+<div style="text-align: center;">
     <a href="https://keepachangelog.com/en/1.1.0/">
         <img alt="Static Badge" src="https://img.shields.io/badge/Keep%20a%20Changelog-v1.1.0-salmon?logo=keepachangelog&logoColor=black&labelColor=white&link=https%3A%2F%2Fkeepachangelog.com%2Fen%2F1.1.0%2F">
     </a>
@@ -36,14 +36,6 @@
 
 ## v1.2.0 (2024-07-15)
 
-### 🔧 Code Refactoring
-
-- optimize database queries for user data retrieval *(Charlie Green - e7c1d8b)*
-
----
-
-## v1.2.0.rc0 (2024-06-10)
-
 ### 🐛 Bug Fixes
 
 - **frontend**: correct layout issues in user profile page *(Bob Smith - c3e7b3b)*
@@ -52,6 +44,10 @@
 
 - update API documentation for user endpoint *(Eve Martin - f8d7e1c)*
 
+### 🔧 Code Refactoring
+
+- optimize database queries for user data retrieval *(Charlie Green - e7c1d8b)*
+
 ---
 
 ## v1.1.0 (2024-05-23)
@@ -102,7 +98,7 @@
 
 ---
 
-<div align="center">
+<div style="text-align: center;">
     <small>
         <b>
             <a href="https://www.github.com/espressif/cz-plugin-espressif">Commitizen Espressif plugin</a>

tests/__snapshots__/test_changelog/test_changelog_czespressif_full_no_emoji.md

@@ -7,7 +7,7 @@
 > All notable changes to this project are documented in this file.
 > This list is not exhaustive - only important changes, fixes, and new features in the code are reflected here.
 
-<div align="center">
+<div style="text-align: center;">
     <a href="https://keepachangelog.com/en/1.1.0/">
         <img alt="Static Badge" src="https://img.shields.io/badge/Keep%20a%20Changelog-v1.1.0-salmon?logo=keepachangelog&logoColor=black&labelColor=white&link=https%3A%2F%2Fkeepachangelog.com%2Fen%2F1.1.0%2F">
     </a>
@@ -36,14 +36,6 @@
 
 ## v1.2.0 (2024-07-15)
 
-### Code Refactoring
-
-- optimize database queries for user data retrieval *(Charlie Green - e7c1d8b)*
-
----
-
-## v1.2.0.rc0 (2024-06-10)
-
 ### Bug Fixes
 
 - **frontend**: correct layout issues in user profile page *(Bob Smith - c3e7b3b)*
@@ -52,6 +44,10 @@
 
 - update API documentation for user endpoint *(Eve Martin - f8d7e1c)*
 
+### Code Refactoring
+
+- optimize database queries for user data retrieval *(Charlie Green - e7c1d8b)*
+
 ---
 
 ## v1.1.0 (2024-05-23)
@@ -102,7 +98,7 @@
 
 ---
 
-<div align="center">
+<div style="text-align: center;">
     <small>
         <b>
             <a href="https://www.github.com/espressif/cz-plugin-espressif">Commitizen Espressif plugin</a>

tests/__snapshots__/test_czespressif/test_example.md

@@ -16,6 +16,7 @@ Commit types in this project:
 
   feat: A new feature
   fix: A bug fix
+  perf: A code change that improves performance
   docs: Documentation only change
   refactor: A changeset neither fixing a bug nor adding a feature
   remove: Removing code or files