Edit CONTRIBUTING.md

This commit is contained in:
Речкина Елена Валерьевна
2025-05-27 11:55:48 +00:00
parent 462672b434
commit d0c4ea2766
+16 -2
View File
@@ -49,16 +49,30 @@
- Текстовый редактор с поддержкой синтаксиса `markdown`. Рекомендуется использовать VSCode. - Текстовый редактор с поддержкой синтаксиса `markdown`. Рекомендуется использовать VSCode.
1. Клонируйте репозиторий в директорию на вашем компьютере. 1. Клонируйте репозиторий в директорию на вашем компьютере.
2. Откройте содержимое директории проекта в редакторе. 2. Откройте репозиторий в VSCode.
3. В VSCode откройте терминал. 3. В VSCode откройте терминал.
4. Установите `npm` командой: 4. Установите `npm` командой:
```sh ```sh
npm install npm install
``` ```
Данный шаг выполняется единожды, чтобы установить `npm` в директории проекта для запуска сборки портала документации. Данный шаг выполняется единожды, чтобы установить `npm` в репозитории для запуска сборки портала документации.
5. Запустите сборку документации командой в терминале: 5. Запустите сборку документации командой в терминале:
```sh ```sh
npm run dev npm run dev
``` ```
6. В результате выполнения команды сформирована ссылка на портал документации вида: http://localhost:5173/docs/. Откройте ссылку в браузере для просмотра портала документации. Ссылка будет доступна только с вашего компьютера. 6. В результате выполнения команды сформирована ссылка на портал документации вида: http://localhost:5173/docs/. Откройте ссылку в браузере для просмотра портала документации. Ссылка будет доступна только с вашего компьютера.
### Вопросы и ответы
**Не устанавливается `npm`**
Если при выполнении команды `npm install` не проходит проверка сертификатов, то выполните следующее:
1. В файл `.npmr` c самой первой строчкой добавить `cafile=VimpelcomCAG2.pem`. Файл `.npmr` должен выглядеть так:
```text
cafile=VimpelcomCAG2.pem
registry=https://nexus.vimpelcom.ru/repository/npm-all/
```
2. В корень репозитория положить файл сертификата `VimpelcomCAG2.pem`. Файл можно скачать: https://git.vimpelcom.ru/products/vega/frontend/-/blob/beecloud99/VimpelcomCAG2.pem?ref_type=heads.
3. Повторите установку `npm`.