docs: added info, rules for the project
This commit is contained in:
29
README.md
29
README.md
@@ -0,0 +1,29 @@
|
||||
# Web-robot-control
|
||||
|
||||
**Web-robot-control** - open source веб-приложение для управлением роботом и трансляции видео с веб-камеры.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<strong>
|
||||
Как оформлять ветки и коммиты
|
||||
</strong>
|
||||
</summary>
|
||||
|
||||
Пример ветки `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/
|
||||
</details>
|
||||
Reference in New Issue
Block a user