reactjs / ru.reactjs.org

React documentation website in Russian / Официальная русская версия сайта React

ru.reactjs.org

Этот репозиторий содержит исходный код и содержимое сайта ru.reactjs.org.

Начало

Предварительные требования

1. Git
2. Node: любая версия 12.x, начиная с 12.0.0 или выше
3. Yarn v1: Посмотрите сайт Yarn с инструкциями по установке
4. Сделать форк этого репозитория (для предложения изменений)
5. Копия репозитория ru.reactjs.org на вашем компьютере

Установка

1. cd ru.reactjs.org для перехода в директорию проекта
2. yarn для установки npm-зависимостей проекта

Запуск проекта локально

1. yarn dev для старта сервера в режиме разработки с поддержкой перезагрузки на лету (на основе Gatsby)
2. open http://localhost:8000 откроет сайт в вашем браузере по умолчанию

Помощь проекту

Рекомендации

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

Создание ветки

1. git checkout main из любой папки в вашей локальной копии репозитория ru.reactjs.org
2. git pull origin main, чтобы убедиться, что у вас самая последняя версия кода
3. git checkout -b the-name-of-my-branch (замените the-name-of-my-branch на подходящее имя) для создания ветки

Внесение изменений

1. Следуйте инструкциям из раздела «Запуск проекта локально»
2. Сохраните файлы и проверьте в вашем браузере
3. Изменения в React-компонентах внутри src применяются на лету
4. Изменения в markdown-файлах внутри content применяются на лету
5. При работе с плагинами может понадобится удаление папки .cache и перезапуск сервера

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

1. По возможности проверьте визуальные изменения во всех последних версиях распространённых браузеров: и настольных, и мобильных.
2. Запустите yarn check-all из корня проекта. (Это запустит Prettier, ESLint и Flow.)

Отправка изменений

1. git add -A && git commit -m "Сообщение" (вместо Сообщение напишите осмысленное название изменения, например Исправление логотипа на Android), чтобы добавить и зафиксировать изменение
2. git push my-fork-name the-name-of-my-branch
3. Перейдите на страницу репозитория ru.reactjs.org и вы увидите уведомление с вашей веткой.
4. Следуйте инструкциям на GitHub.
5. По возможности добавьте скриншот с сделанными изменениями. Как только вы сделаете PR, автоматически будет создана версия сайта с вашими изменениями на Netlify.

Перевод

Если вы заинтересованы в переводе reactjs.org, ознакомьтесь с текущим прогрессом перевода на translations.reactjs.org.

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

• yarn reset для очистки локального кеша

Лицензия

Контент на ru.reactjs.org распространяется по лицензии CC-BY-4.0, как указано в файле LICENSE-DOCS.md.