diff --git a/CODE_STANDART.md b/CODE_STANDART.md index 92dce3a..f7bce43 100644 --- a/CODE_STANDART.md +++ b/CODE_STANDART.md @@ -63,6 +63,27 @@ const page: ReactNode = lazy(() => import (...)) ``` +### 1.4. Работа с репозиторием + +#### 1.4.1. Подготовка к публикации работы по заданию +При получений задания необходимо создать для неё ветку, наследуемую от **dev**. +Ветка должна именоваться в **kebab-case** и иметь префикс соответствующий типу задачи: +* "**feature/**" - для нового функционала или визуала; +* "**fix/**" - для багов и любых исправлений. + +Название ветки должно кратко описывать проблему или новые возможности. + +Далее необходимо создать *pull request* на ветку dev от новосозданной и сразу отметить его как WIP. +При завершении задания метку WIP необходимо снять. + +#### 1.4.2 Оформление коммита +Изменения файлов необходимо разделять на коммиты по общим изменениям и соответствующе его именовать. +Если в коммит попадает более одного логического изменения стоит указывать их в виде маркированного списка, например: +``` + * На странице "Мониторинг" и "Архив" сокращено колличество запросов; + * Страница "Сообщения" удалена. +``` + ## 2. JS 1. Методы, константы и переменные документируются в соответствии с `JSDoc`; 2. При документации страниц необходимо указать её название, краткое описание и описание получаемых параметров: