From 253c05346c90c02602674646cc66bfe74246ac1b Mon Sep 17 00:00:00 2001
From: Arduinum <message.chaos628@gmail.com>
Date: Wed, 29 Jan 2025 13:15:23 +0300
Subject: [PATCH] docs: added "How to format branches and commits" in the
 README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 75821c6..b4e4a3e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
 # kawai-focus
 Kawai.Focus - приложение для фокусировки внимания на основе таймера Pomodoro.
+
+<details>
+  <summary>
+    <strong>
+      Как оформлять ветки и коммиты
+    </strong>
+  </summary>
+
+Пример ветки `nickname/name_task`
+
+- **nickname** (никнейм в github);
+- **name_task** (название задачи - название карточки на yougile).
+
+Пример коммита `refactor: renaming a variable`
+
+- **feat:** (новая функционал кода, БЕЗ учёта функционала для сборок);
+- **devops:** (функционал для сборки, - добавление, удаление и исправление);
+- **fix:** (исправление ошибок функционального кода);
+- **docs:** (изменения в документации);
+- **style:** (форматирование, отсутствующие точки с запятой и т.п., без изменения производственного кода);
+- **refactor:** (рефакторинг производственного кода, например, переименование переменной);
+- **test:** (добавление недостающих тестов, рефакторинг тестов; без изменения производственного кода);
+- **chore:** (обновление рутинных задач и т. д.; без изменения производственного кода). 
+
+Оформление основано на https://www.conventionalcommits.org/en/v1.0.0/
+</details>
\ No newline at end of file