From 82a3d742518d0a3066f5ec72c408fd965b4cdf6d Mon Sep 17 00:00:00 2001
From: sed-i <82407168+sed-i@users.noreply.github.com>
Date: Thu, 18 May 2023 23:53:06 -0400
Subject: [PATCH] Conventional X

---
 .../cheatsheet/conventional-comments.md       | 52 ------------
 docs/software/cheatsheet/conventional.md      | 84 +++++++++++++++++++
 mkdocs.yml                                    |  2 +-
 3 files changed, 85 insertions(+), 53 deletions(-)
 delete mode 100644 docs/software/cheatsheet/conventional-comments.md
 create mode 100644 docs/software/cheatsheet/conventional.md

diff --git a/docs/software/cheatsheet/conventional-comments.md b/docs/software/cheatsheet/conventional-comments.md
deleted file mode 100644
index ddad541..0000000
--- a/docs/software/cheatsheet/conventional-comments.md
+++ /dev/null
@@ -1,52 +0,0 @@
-# Conventional comments
-https://conventionalcomments.org/
-
-
-- `suggestion (blocking)` is similar to `todo`. Omitting `todo`.
-- An actionable `thought`/`note` is a `question`. Omitting `question`, `note`.
-
-
-> **Praise:**
->
-> - Highlight something positive
-> - Do not leave false praise
-
----
-
-> **Nitpick:**
->
-> - Non-blocking
-> - Preference-based
-
----
-
-> **Polish:** / **Typo:**
->
-> - Immediate quality improvement
-
----
-
-> **Suggestion (non-blocking):**
->
-> - Propose improvements (what + why)
-
----
-
-> **Question:**
->
-> - Uncertain about a potential concern
-> - Clarification request
-
----
-
-> **Issue:**
->
-> - Highlight specific problem
-> - Pair with a `Suggestion`
-
----
-
-> **Chore:**
->
-> - Need to follow some existing policy/process
-
diff --git a/docs/software/cheatsheet/conventional.md b/docs/software/cheatsheet/conventional.md
new file mode 100644
index 0000000..7a8d9e8
--- /dev/null
+++ b/docs/software/cheatsheet/conventional.md
@@ -0,0 +1,84 @@
+## Comments
+https://conventionalcomments.org/
+
+
+- `suggestion (blocking)` is similar to `todo`. Omitting `todo`.
+- An actionable `thought`/`note` is a `question`. Omitting `question`, `note`.
+
+
+```
+**Praise:** Title
+
+Highlight something positive (do not leave false praise)
+```
+
+---
+
+```
+**Nitpick:** Title
+
+Non-blocking, preference-based
+```
+
+---
+
+```
+**Polish:** / **Typo:** Title
+
+Immediate quality improvement
+```
+
+---
+
+```
+**Suggestion (non-blocking):** Title
+
+Propose improvements (what + why)
+```
+
+---
+
+```
+**Question:** Title
+
+Uncertain about a potential concern (clarification request)
+```
+
+---
+
+```
+**Issue:** Title
+
+Highlight specific problem
+
+
+**Suggestion:** Title
+
+Propose improvements (what + why)
+```
+
+---
+
+```
+**Chore:** Title
+
+Need to follow some existing policy/process
+```
+
+
+## Commits
+https://www.conventionalcommits.org/en/
+
+| Commit type        | SemVer    | Notes                     |
+|--------------------|-----------|---------------------------|
+| `fix(scope):`      | PATCH     | Patch a bug               |
+| `feat(scope):`     | MINOR     | Introduce new feature     |
+| `<type>!:`         | MAJOR     | `BREAKING CHANGE:` footer |
+| `test(scope):`     |           |                           |
+| `refactor(scope):` |           |                           |
+| `perf(scope):`     |           |                           |
+| `docs(scope):`     |           |                           |
+| `style(scope):`    |           |                           |
+| `ci(scope):`       |           |                           |
+| `revert:`          | (Depends) | `Refs:` footer            |
+
diff --git a/mkdocs.yml b/mkdocs.yml
index 599cc42..5325358 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -14,7 +14,7 @@ nav:
       - Charmcraft: 'software/cheatsheet/charmcraft.md'
       - 'Python multiprocessing': 'software/cheatsheet/python-multiprocessing.md'
       - Archives: 'software/cheatsheet/archives.md'
-      - 'Conventional comments': 'software/cheatsheet/conventional-comments.md'
+      - 'Conventional X': 'software/cheatsheet/conventional.md'
       - 'Remote host': 'software/cheatsheet/remote-host.md'
       - 'SSH': 'software/cheatsheet/ssh.md'
     - Reference: