diff --git a/README.md b/README.md index e69de29..9a607c6 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,29 @@ +# Web-robot-control + +**Web-robot-control** - open source веб-приложение для управлением роботом и трансляции видео с веб-камеры. + +
+ + + Как оформлять ветки и коммиты + + + + Пример ветки `user_name/name_task` + + - **user_name** (имя пользователя); + - **name_task** (название задачи). + + Пример коммита `refactor: renaming a variable` + + - **feat:** (новая функционал кода, БЕЗ учёта функционала для сборок); + - **devops:** (функционал для сборки, - добавление, удаление и исправление); + - **fix:** (исправление ошибок функционального кода); + - **docs:** (изменения в документации); + - **style:** (форматирование, отсутствующие точки с запятой и т.п., без изменения производственного кода); + - **refactor:** (рефакторинг производственного кода, например, переименование переменной); + - **test:** (добавление недостающих тестов, рефакторинг тестов; без изменения производственного кода); + - **chore:** (обновление рутинных задач и т. д.; без изменения производственного кода). + + Оформление основано на https://www.conventionalcommits.org/en/v1.0.0/ +
\ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 3ac6940..eb64e24 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "web-robot-control" version = "0.1.0" -description = "Web-robot-control - веб-приложение для управлением роботом и трансляции видео с веб-камеры." +description = "Web-robot-control - open source веб-приложение для управлением роботом и трансляции видео с веб-камеры." authors = [ {name = "Arduinum628",email = "message.chaos628@gmail.com"} ]