From 9461dc9ff4aa8ffc91691f0d2a0867980e224e8c Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Fri, 20 Jan 2023 18:30:08 +0100
Subject: [PATCH 1/3] docs: add commit cli

---
 .DS_Store      | Bin 0 -> 6148 bytes
 docs/commit.md |  11 +++++++++++
 mkdocs.yml     |   1 +
 3 files changed, 12 insertions(+)
 create mode 100644 .DS_Store
 create mode 100644 docs/commit.md

diff --git a/.DS_Store b/.DS_Store
new file mode 100644
index 0000000000000000000000000000000000000000..bba9e6c719063294d4731627ea7628928b2c380a
GIT binary patch
literal 6148
zcmeHK%SyvQ6rHirrW7Fyg)Rr&7VJ|HHzC#^Fro{UnvkHum?=$a7p0K3{*Yhd_jvEj
zL@d^=h`kqP&V9~g4rCsTG49QxE@KX3%!Y=@QCTDCUK`pn$%q`s2<Q1EOl1i6n~D8(
zz;Cx$&JtFz`0MwFlQhYTPUoF()vWEEx?Q)M_O1UQ=YA0sv)l`&*JxcxnTC}fgqKM?
zA3J-eGAn{4i>Im}iDF2(xk|D~&OJHHqFmMbI$$^K#@J~s7TsaLEqcSjvMm<Jy-r&U
z`bW!U!`?qQJUJgfrcarC(S&l~Tgk4$3SL3^T+g#V%~F}&gRjc3@(76mVt^PR1~!)g
zb0*l$&82`=P7DwOKQMs%gMfzU8Z0%ctphr|K4aWML;)S&5{SZ}Yp~P^5fH9R0d*-i
zPYkZh!7ognYp~R)%NbWQ!#HN<>hZ$W?BEwFopDzq^~3-%u*yJ9n+~4;XYk9cedMo}
zkVOm-1OJQxZjJnr2a7Ui>$m0MSu3F3K|{g35)}~8S1tiy;6Bn)K^+&UL!N7})QF>?
SUzG#WML-ck9Wn3=4154wZ%SkU

literal 0
HcmV?d00001

diff --git a/docs/commit.md b/docs/commit.md
new file mode 100644
index 0000000000..c3a4ed2def
--- /dev/null
+++ b/docs/commit.md
@@ -0,0 +1,11 @@
+![Using commitizen cli](images/demo.gif)
+
+## About
+
+In your terminal run `cz commit` or the shortcut `cz c` to generate a guided git commit.
+
+A commit can be signed off using `cz commit --signoff` or the shortcut `cz commit -s`.
+
+!!! note
+    To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
+    In particular pre-commit hooks coloring will be deactivated.
diff --git a/mkdocs.yml b/mkdocs.yml
index 038581b0b2..7d8dc430b0 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -12,6 +12,7 @@ nav:
     - Introduction: 'README.md'
     - Commands:
         - Init: 'init.md'
+        - Commit: 'commit.md'
         - Bump: 'bump.md'
         - Check: 'check.md'
         - Changelog: 'changelog.md'

From 62e7ca59feedd9834feb0861579cfbb7b5fff59d Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Sat, 21 Jan 2023 14:04:43 +0100
Subject: [PATCH 2/3] docs: reference related issue commit page

---
 docs/commit.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/commit.md b/docs/commit.md
index c3a4ed2def..fb3fdd65ac 100644
--- a/docs/commit.md
+++ b/docs/commit.md
@@ -8,4 +8,4 @@ A commit can be signed off using `cz commit --signoff` or the shortcut `cz commi
 
 !!! note
     To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
-    In particular pre-commit hooks coloring will be deactivated.
+    In particular pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).

From 5b604e2aef331a2efd2459dddb95dac9f812fc3b Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Sat, 21 Jan 2023 14:07:25 +0100
Subject: [PATCH 3/3] build: add .DS_Store file to .gitignore

---
 .DS_Store  | Bin 6148 -> 0 bytes
 .gitignore |   3 +++
 2 files changed, 3 insertions(+)
 delete mode 100644 .DS_Store

diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index bba9e6c719063294d4731627ea7628928b2c380a..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 6148
zcmeHK%SyvQ6rHirrW7Fyg)Rr&7VJ|HHzC#^Fro{UnvkHum?=$a7p0K3{*Yhd_jvEj
zL@d^=h`kqP&V9~g4rCsTG49QxE@KX3%!Y=@QCTDCUK`pn$%q`s2<Q1EOl1i6n~D8(
zz;Cx$&JtFz`0MwFlQhYTPUoF()vWEEx?Q)M_O1UQ=YA0sv)l`&*JxcxnTC}fgqKM?
zA3J-eGAn{4i>Im}iDF2(xk|D~&OJHHqFmMbI$$^K#@J~s7TsaLEqcSjvMm<Jy-r&U
z`bW!U!`?qQJUJgfrcarC(S&l~Tgk4$3SL3^T+g#V%~F}&gRjc3@(76mVt^PR1~!)g
zb0*l$&82`=P7DwOKQMs%gMfzU8Z0%ctphr|K4aWML;)S&5{SZ}Yp~P^5fH9R0d*-i
zPYkZh!7ognYp~R)%NbWQ!#HN<>hZ$W?BEwFopDzq^~3-%u*yJ9n+~4;XYk9cedMo}
zkVOm-1OJQxZjJnr2a7Ui>$m0MSu3F3K|{g35)}~8S1tiy;6Bn)K^+&UL!N7})QF>?
SUzG#WML-ck9Wn3=4154wZ%SkU

diff --git a/.gitignore b/.gitignore
index 5b4e933e35..987c1a9c60 100644
--- a/.gitignore
+++ b/.gitignore
@@ -110,3 +110,6 @@ venv.bak/
 
 # build
 poetry.lock
+
+# macOSX
+.DS_Store