Docs/recommend pipx

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 minimum_pre_commit_version: 3.3.0
 default_install_hook_types: [pre-commit, commit-msg]
-default_stages: [commit]
+default_stages: [pre-commit]
 
 exclude: '^tests/__snapshots__/'
 

README.md

@@ -51,22 +51,22 @@ All of this with minimal config and setup, so your `pyproject.toml` file stays c
   <hr>
 </div>
 
-- [Commitizen plugin czEspressif](#commitizen-plugin-czespressif)
+- [Commitizen Plugin `czEspressif`](#commitizen-plugin-czespressif)
   - [Features](#features)
   - [Compatibility](#compatibility)
   - [Install](#install)
   - [Usage](#usage)
-    - [Create Changelog file](#create-changelog-file)
-    - [Bump Release version](#bump-release-version)
+    - [Create Changelog File](#create-changelog-file)
+    - [Bump Release Version](#bump-release-version)
     - [GitHub Action for Automated Release Creation](#github-action-for-automated-release-creation)
-    - [Create commit messages](#create-commit-messages)
-    - [Examples of good commit messages](#examples-of-good-commit-messages)
+    - [Create Commit Messages](#create-commit-messages)
+    - [Examples of Good Commit Messages](#examples-of-good-commit-messages)
   - [Configuration](#configuration)
-    - [Minimal setup](#minimal-setup)
-    - [Optimal setup](#optimal-setup)
-    - [Additional configurable parameters](#additional-configurable-parameters)
+    - [Minimal Setup](#minimal-setup)
+    - [Optimal Setup](#optimal-setup)
+    - [Additional Configurable Parameters](#additional-configurable-parameters)
   - [Solving Troubles](#solving-troubles)
-  - [Pre-commit hook (beta)](#pre-commit-hook-beta)
+  - [Pre-Commit Hook (Beta)](#pre-commit-hook-beta)
   - [Contributing](#contributing)
   - [License](#license)
   - [Credits](#credits)
@@ -120,9 +120,14 @@ cz example
 >
 > commitizen itself is in the plugin's dependencies, so pip will take care of everything.
 
-> \[!WARNING\]
-> Don't try to install it system-wide with `pipx`; it likely won't work as expected.
-> (This option will be explored in the future, and once a solution is found, we will update this recommendation.)
+To use the plugin system-wide, you can install it with `pipx`:
+
+```sh
+pipx install commitizen
+pipx inject commitizen czespressif
+```
+
+This will install `czespressif` as a plugin for the global `commitizen` installation, allowing you to use it in any project without needing to install it separately for each one.
 
 ---
 
@@ -292,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',
@@ -305,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',
@@ -317,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',
@@ -100,7 +108,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>
@@ -115,7 +123,7 @@
 """
 
 CHANGELOG_FOOTER: str = f"""
-<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_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