Conventional X

sed-i · May 19, 2023 · 82a3d74 · 82a3d74
1 parent 4fced08
commit 82a3d74
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 53 deletions.
diff --git a/docs/software/cheatsheet/conventional-comments.md b/docs/software/cheatsheet/conventional-comments.md
diff --git a/docs/software/cheatsheet/conventional.md 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
@@ -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: