diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bacc75..08dac4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Слияние вашей ветки с веткой *main* и релиз документации выполняет ответственный за портал документации. -**Важно.** Название ветки должно начинаться с префикса *feature/*. Это необходимо для публикации MR на тестовом стенде Vega для проведения ревью. +**Важно.** Название ветки должно начинаться с префикса *feature/*. Это необходимо для публикации MR на тестовом стенде для проведения ревью. 1. Перейдите в git-репозитории https://git.vimpelcom.ru/common/vega/beecloud-docs 2. Создайте отдельную ветку для внесения изменений: @@ -43,8 +43,13 @@ Доступна публикация портала документации локально. Публикация в интернете пока недоступна. +Требования: + +- `Node.js` версии 18 и выше. +- Текстовый редактор с поддержкой синтаксиса `markdown`. Рекомендуется использовать VSCode. + 1. Клонируйте репозиторий в директорию на вашем компьютере. -2. Откройте содержимое директории проекта в редакторе. Рекомендуется использовать VSCode. +2. Откройте содержимое директории проекта в редакторе. 3. В VSCode откройте терминал. 4. Установите `npm` командой: ```sh