From 40dd056136d1ca5dc577e4c6524f65c30559baf3 Mon Sep 17 00:00:00 2001
From: Dima Denisenko <1253839+dimdnk@users.noreply.github.com>
Date: Wed, 9 Oct 2024 14:01:29 +0300
Subject: [PATCH] docs: add semantic commits notes

---
 .github/ISSUE_TEMPLATE/config.yml |  2 +-
 .github/SEMANTIC_COMMITS.md       | 34 +++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 .github/SEMANTIC_COMMITS.md

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index ec4bb38..3ba13e0 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1 +1 @@
-blank_issues_enabled: false
\ No newline at end of file
+blank_issues_enabled: false
diff --git a/.github/SEMANTIC_COMMITS.md b/.github/SEMANTIC_COMMITS.md
new file mode 100644
index 0000000..2297468
--- /dev/null
+++ b/.github/SEMANTIC_COMMITS.md
@@ -0,0 +1,34 @@
+# Semantic Commit Messages
+
+See how a minor change to your commit message style can make you a better programmer.
+
+Format: `<type>(<scope>): <subject>`
+
+`<scope>` is optional
+
+## Example
+
+```
+feat: add hat wobble
+^--^  ^------------^
+|     |
+|     +-> Summary in present tense.
+|
++-------> Type: chore, docs, feat, fix, refactor, style, or test.
+```
+
+More Examples:
+
+- `feat`: (new feature for the user, not a new feature for build script)
+- `fix`: (bug fix for the user, not a fix to a build script)
+- `docs`: (changes to the documentation)
+- `style`: (formatting, missing semi colons, etc; no production code change)
+- `refactor`: (refactoring production code, eg. renaming a variable)
+- `test`: (adding missing tests, refactoring tests; no production code change)
+- `chore`: (updating grunt tasks etc; no production code change)
+
+References:
+
+- https://www.conventionalcommits.org/
+- https://seesparkbox.com/foundry/semantic_commit_messages
+- http://karma-runner.github.io/1.0/dev/git-commit-msg.html