Инструкция по разработке

Этот раздел содержит информацию, необходимую для начала работы с проектом и его дальнейшей разработки. Следуя этим шагам, вы сможете настроить окружение, установить все зависимости и запустить проект на своем компьютере. Также здесь описаны основные этапы работы с репозиторием и взаимодействия с командой.

Прежде чем приступить к установке и настройке, убедитесь, что у вас есть все необходимые инструменты, такие как Node.js и npm (или yarn). Убедитесь, что ваш SSH-ключ добавлен в настройки GitHub, чтобы иметь возможность взаимодействовать с репозиторием.

Эта инструкция охватывает следующие этапы:

Установка всех зависимостей проекта.
Запуск тестов для проверки корректности работы.
Описание шагов для эффективной разработки, создания новых веток и отправки изменений в репозиторий.
Рекомендации по внесению изменений и созданию Pull Request.

Следуя этому руководству, вы сможете быстро настроить рабочее окружение и внести свой вклад в проект.

Вот пример текста, который можно добавить под заголовком "# Инструкция по разработке":

Требования:

Перед тем как начать работу с проектом, убедитесь, что у вас установлены следующие инструменты:

Node.js (версия 20.x и выше) — для работы с JavaScript и запуском серверной части.
npm или yarn — менеджеры пакетов для установки зависимостей.
Публичный SSH-ключ в настройках организации на GitHub для доступа к репозиториям.

Установка зависимостей:

Для начала работы с проектом выполните несколько простых шагов.

Клонирование репозитория
Клонируйте репозиторий на свою машину с помощью команды:
git clone https://github.com/asianetsievskaya/box-ad-player.git
Установка зависимостей
После того как репозиторий клонирован, перейдите в директорию проекта и установите все необходимые зависимости с помощью команды:
npm ci
Эта команда установит все зависимости, указанные в файле package-lock.json, гарантируя, что у всех разработчиков будут одинаковые версии пакетов.
Запуск
npm run test

Разработка и вклад в проект

Создание новой ветки: Рекомендуется создавать новую ветку для каждой фичи или исправления ошибки. Для этого выполните команду:
git checkout -b название-ветки
Работа с кодом: Пишите код, добавляйте новые фичи и исправляйте ошибки, следуя стандартам проекта.
Коммиты и пуши: Пишите осмысленные сообщения к коммитам, описывая, что было сделано. После завершения работы с веткой выполните команду для отправки изменений в удалённый репозиторий:
git push origin название-ветки
Pull Request: После завершения работы откройте Pull Request для того, чтобы ваша ветка была проверена и объединена с основной.

Примечания

Все команды и инструкции предполагают использование Git и npm.
Для работы с проектом вам потребуется доступ к репозиториям GitHub с публичным SSH-ключом. Убедитесь, что ваш SSH-ключ добавлен в настройки вашей организации на GitHub.

Этот текст описывает базовые шаги для установки и запуска проекта, а также добавляет инструкции для разработки и вклада в проект.

12 April 2025