docs: added "How to format branches and commits" in the README.md

This commit is contained in:
Arduinum
2025-01-29 13:15:23 +03:00
parent 698f267cf3
commit 253c05346c

View File

@@ -1,2 +1,28 @@
# kawai-focus # kawai-focus
Kawai.Focus - приложение для фокусировки внимания на основе таймера Pomodoro. 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>