From 473f17cfa625f427c57ba7321808217d2f4f401f Mon Sep 17 00:00:00 2001
From: Ivan <8611739+IRBorisov@users.noreply.github.com>
Date: Fri, 26 Jul 2024 00:40:15 +0300
Subject: [PATCH] I: include commit convention

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 60db14af..0cd1c179 100644
--- a/README.md
+++ b/README.md
@@ -11,13 +11,14 @@
 [![Frontend CI](https://github.com/IRBorisov/ConceptPortal/actions/workflows/frontend.yml/badge.svg?branch=main)](https://github.com/IRBorisov/ConceptPortal/actions/workflows/frontend.yml)
 
 React + Django based web portal for editing RSForm schemas.
-This readme file is used mostly to document project dependencies
+This readme file is used mostly to document project dependencies and conventions.
 
 ## ❤️ Contributing notes
 
 - feel free to open issues, discussion topics, contact maintainer directly
 - use Test config in VSCode to run tests before pushing commits / requests
 - use github actions to setup linter checks and test builds
+- use conventional commits to describe changes
 
 ## ✨ Frontend [Vite + React + Typescript]
 
@@ -138,6 +139,14 @@ This readme file is used mostly to document project dependencies
 
 # Developer Notes
 
+## 📝 Commit conventions
+
+- 🚀 F: major feature implementation
+- 💄 D: UI design
+- 🚑 B: bug fix
+- 🔧 R: refactoring and code improvement
+- 📝 I: documentation
+
 ## 🖥️ Local build (Windows 10+)
 
 This is the build for local Development