Skip to content

Latest commit

 

History

History
17 lines (15 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

17 lines (15 loc) · 2.87 KB

Contributing

General rules

  • коммиты создаются с помощью утилиты commitizen поэтому вместо команды git commit необходимо выполнять npm run cz и следовать дальнейшим указаниям выводимым в терминал.

Contributing for book

Правила для редактирования раздела "Книга"

Contributing for what-is-new

Правила для редактирования раздела "Что нового?"

Contributing for www (web application)

Для того чтобы запустить приложение в dev режиме необходимо соблюсти несколько условий -

  1. Сделать fork репозитория
  2. Клонировать репозиторий полученный на первом шаге на локальную машину
  3. установить npm зависимости с помощью команды npm i после выполнения которой автоматически запустится npm hook postinstall и создаст в корневой директории файл .env.github.development.
  4. Заполнить все поля в созданном файле
  5. Запустить приложения с помощью команды npm run develop

Стоит обратить внимание, что файл .env.github.development будет содержать три обязательных не заполненных поля, которые необходимо указать до запуска приложения. Это необходимо поскольку для сборки приложения необходима информация предоставляемая github который предоставляет свое graphql api только авторизованным пользователям. Поэтому в созданном файле необходимо ввести имя github пользователя, имя ветки и сгенерированный github token. Стоит заметить что эти данные не будут отправлены в удаленный репозиторий поскольку файл .env.github.development уже добавлен в .gitignore. Стоит также упомянуть что при создании новой ветки изменять данные файла .env.github.development не требуется поскольку обращения будут происходить за данными о файлах из прежней ветки.