Перейти к основному содержимому

Для разработчиков

Это руководство предназначено для разработчиков, которые хотят работать с нашей документацией локально на своем компьютере. Здесь вы узнаете, как склонировать репозиторий, установить необходимые зависимости, запускать локальный сервер для предварительного просмотра изменений и вносить свой вклад через коммиты и Pull Requests.

Что вам понадобится​

  • Git: система контроля версий для управления кодом. Если у вас не установлена, скачайте и установите с официального сайта.
  • Node.js и npm: платформа для запуска JavaScript вне браузера и менеджер пакетов. Скачайте LTS-версию с официального сайта.
  • Текстовый редактор или IDE: например, Visual Studio Code, WebStorm или другой на ваш выбор.
  • Аккаунт на GitHub: если у вас его еще нет, зарегистрируйтесь на github.com.

Пошаговая инструкция​

1. Клонирование репозитория​

  1. Откройте терминал (Command Prompt, PowerShell или терминал в вашей IDE).
  2. Перейдите в директорию, где вы хотите разместить проект: 
    cd путь/к/вашей/директории
  3. Склонируйте репозиторий: 
    git clone https://github.com/WaneTol72/rdw-test-docs.git
  4. Перейдите в папку проекта: 
    cd rdw-test-docs

2. Установка зависимостей​

  1. Проверьте версии Node.js и npm: 
    node -v
    npm -v
    Убедитесь, что установлена рекомендуемая версия Node.js (LTS).
  2. Установите необходимые пакеты: 
    npm install

3. Запуск локального сервера​

  1. Запустите сервер разработки: 
    npm start
  2. Откройте браузер и перейдите по адресу http://localhost:3000. Вы увидите локальную версию сайта документации.
  3. Горячая перезагрузка: любые изменения в файлах автоматически обновятся в браузере.

4. Внесение изменений​

  1. Откройте проект в вашем текстовом редакторе или IDE.
  2. Найдите нужные файлы в папке docs/ для документации или src/ для исходного кода.
  3. Вносите изменения, используя синтаксис Markdown или JSX, в зависимости от файла.
  4. Сохраняйте файлы после каждого изменения.

5. Проверка изменений​

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

6. Коммит изменений​

  1. Проверьте статус репозитория: 
    git status
  2. Добавьте измененные файлы: 
    git add путь/к/файлу.md
    Или добавьте все изменения: 
    git add .
  3. Создайте коммит с информативным сообщением: 
    git commit -m "Добавил раздел о работе с Git"

7. Создание новой ветки (рекомендуется)​

  1. Создайте новую ветку для ваших изменений: 
    git checkout -b feature/название-вашей-ветки
    Пример: 
    git checkout -b feature/update-testing-guide

8. Отправка изменений на GitHub​

  1. Отправьте вашу ветку в удаленный репозиторий: 
    git push origin feature/название-вашей-ветки
  2. Перейдите на GitHub и откройте страницу репозитория.
  3. Создайте Pull Request:
    • GitHub предложит вам создать Pull Request для недавно отправленной ветки.
    • Нажмите "Compare & pull request".
  4. Заполните информацию о Pull Request:
    • Заголовок: кратко опишите изменения.
    • Описание: подробно объясните, какие изменения вы внесли и зачем.
  5. Назначьте ревьюеров (если необходимо) и добавьте теги.
  6. Отправьте Pull Request нажатием кнопки "Create pull request".

9. Ожидание проверки и слияния​

  • Ревью: другие разработчики проверят ваш код.
  • Обсуждение: возможны комментарии или запросы на изменения.
  • Слияние: после одобрения ваш Pull Request будет слит в основную ветку.

Полезные советы​

  • Обновляйте вашу ветку перед созданием Pull Request: 
    git checkout master
    git pull origin master
    git checkout feature/название-вашей-ветки
    git merge master
  • Следуйте стилевым рекомендациям: ознакомьтесь с нашим руководством по стилю.
  • Пишите понятные сообщения коммитов: это облегчит понимание истории изменений.
  • Разбивайте большие изменения на небольшие коммиты или Pull Requests.

Решение проблем​

npm install завершился с ошибками​

  • Удалите папку node_modules и файл package-lock.json, затем повторите npm install.
  • Проверьте версию Node.js: используйте рекомендованную LTS-версию.

Сервер не запускается или падает​

  • Проверьте консоль на наличие ошибок и попробуйте исправить их.
  • Убедитесь, что порт 3000 свободен, или измените порт в настройках.

Конфликты при слиянии веток​

  • Разрешите конфликты вручную в файлах с конфликтами.
  • Сделайте коммит после разрешения конфликтов.

Дополнительные ресурсы​

Заключение​

Работа с проектом локально предоставляет больше возможностей для тестирования и улучшения документации. Вы можете полностью контролировать процесс разработки и видеть результаты в реальном времени.

Спасибо за ваш вклад в развитие нашей документации и инструментария!

Если у вас возникли вопросы или нужна помощь, обратитесь через раздел Обратная связь или свяжитесь напрямую с координатором проекта.