From d8ae3507727391f472aeba034128140e72411e36 Mon Sep 17 00:00:00 2001
From: kabszac <69686216+kabszac@users.noreply.github.com>
Date: Wed, 6 Nov 2024 06:22:42 +0300
Subject: [PATCH] Feat/add release please (#928)

* feat(ci): add release-please GitHub Action for automated releases

Added the release-please github action to automate release versioning
and changelog generation. This workflow will create release pull
requests based on conventional commit messages and update the changelog
accordingly upon merging.

- Configured to trigger on pushes to the main branch
- Set the release type to 'simple'

* docs:ADD ADDITIONAL STYLE GUIDE FOR COMMIT MESSAGE

- Add the conventional commit link to the documentation
- Add the most important prefix types to have in mind when writing a
  commit message
---
 .github/workflows/release-please.yml | 24 ++++++++++++++++++++++++
 CONTRIBUTING.md                      |  9 +++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 .github/workflows/release-please.yml

diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
new file mode 100644
index 00000000..dc4c6487
--- /dev/null
+++ b/.github/workflows/release-please.yml
@@ -0,0 +1,24 @@
+on:
+    push:
+        branches:
+            - main
+
+permissions:
+    contents: write
+    pull-requests: write
+
+name: release-please
+
+jobs:
+    release-please:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: googleapis/release-please-action@v4
+              with:
+                  # this assumes that you have created a personal access token
+                  # (PAT) and configured it as a GitHub action secret named
+                  # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
+                  token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+                  # this is a built-in strategy in release-please, see "Action Inputs"
+                  # for more options
+                  release-type: simple
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 81da64b1..169237cf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -115,6 +115,15 @@ Open the browser to visit the website at http://localhost:3000
 
 **How you can add more value to your contribution logs:**
 
+-   Use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) way when writing your commit messages.
+-   The most important prefixes you should have in mind are:
+
+    -   `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
+        patch.
+    -   `feat:` which represents a new feature, and correlates to a SemVer minor.
+    -   `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
+        (indicated by the `!`) and will result in a SemVer major.
+
 -   Use the present tense. (Example: "Add feature" instead of "Added feature")
 -   Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
 -   Limit the first line (also called the Subject Line) to _50 characters or fewer_.