feat: Add commitizen as a dev dependency, setup commitizen for version bump and maintain changelog

Author: iplitharas

.pre-commit-config.yaml

@@ -1,36 +1,47 @@
 repos:
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--profile", "black", "--filter-files"]
-  - repo: https://github.com/ambv/black
-    rev: 22.12.0
-    hooks:
-      - id: black
-
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint
-        entry: pylint
-        language: system
-        types: [python]
-        files: ^src/
-        pass_filenames: true
-        exclude: ^src/examples/
-        args:
-          - "-rn"
-          - "-sn"
-      - id: mypy
-        name: mypy
-        entry: mypy
-        language: system
-        types: [python]
-        files: ^src/
-        exclude: ^src/examples/
-        args:
-          - "--config-file"
-          - "pyproject.toml"
-          - "--ignore-missing-imports"
+- hooks:
+  - args:
+    - --profile
+    - black
+    - --filter-files
+    id: isort
+    name: isort (python)
+  repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+- hooks:
+  - id: black
+  repo: https://github.com/ambv/black
+  rev: 22.12.0
+- hooks:
+  - args:
+    - -rn
+    - -sn
+    entry: pylint
+    exclude: ^src/examples/
+    files: ^src/
+    id: pylint
+    language: system
+    name: pylint
+    pass_filenames: true
+    types:
+    - python
+  - args:
+    - --config-file
+    - pyproject.toml
+    - --ignore-missing-imports
+    entry: mypy
+    exclude: ^src/examples/
+    files: ^src/
+    id: mypy
+    language: system
+    name: mypy
+    types:
+    - python
+  repo: local
+- hooks:
+  - id: commitizen
+  - id: commitizen-branch
+    stages:
+    - push
+  repo: https://github.com/commitizen-tools/commitizen
+  rev: v3.12.0

poetry.lock

@@ -38,7 +38,16 @@ myst-parser = "^2.0.0"               # MIT
 nbsphinx = "^0.9.3"
 sphinx-copybutton = "^0.5.2"
 recommonmark = "^0.7.1"
+commitizen = "^3.12.0"
 
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_scheme = "semver"
+version_provider = "poetry"
+update_changelog_on_bump = true
+major_version_zero = true
 [build-system]
 requires = [ "setuptools", "wheel"]
 build-backend = "poetry.core.masonry.api"