Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (37 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 2.96 KB

Баги

Проект использует GitHub issues чтобы управлять багами. Мы следим за ними. Перед созданием нового бага, попробуйте убедиться, что ваша проблема еще не существует.

Перед тем, как отправлять PR

Команда рассмотрит ваш PR и либо замержит его, запросит изменения, либо закроет его.

Требования

  • У вас стоит Node.js версии >= 18.x.x и pnpm v8.

  • Вы знакомы с Git.

    Вы также можете использовать GitPod, чтобы мгновенно инициализировать среду разработки онлайн. Просто нажмите кнопку GitPod в README.

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

  • Форкните репозиторий и создайте новую ветку из main.
  • Запустите pnpm i в корне репозитория.
  • Если вы исправили баг или добавили код, который должен быть протестирован, убедитесь, что добавили тесты.
  • Убедитесь, что тесты проходят: pnpm typecheck && pnpm test
  • Убедитесь, что ваш код линтится, запустив pnpm lint.
  • Если ваш вклад исправляет существующую проблему, убедитесь, что вы связали ее с вашим pull request.

Воркфлоу разработки

1. Создайте форк репозитория

Перейдите в репозиторий и создайте форк в вашем аккаунте GitHub.

2. Склонируйте репозиторий

git clone git@github.com:YOUR_USERNAME/pachca.git

3. Установите зависимости

Перейдите в корень репозитория и запустите установку:

cd pachca && pnpm i

Всё готово!

6. Доступные команды

  • pnpm dev запускает сборку в watch режиме.
  • pnpm build создаёт production версию библиотеки.
  • pnpm lint линтит весь код.
  • pnpm test запускает тесты.
  • pnpm typecheck запускает тесты типов.
  • pnpm test:watch запускает тесты в watch режиме.
  • pnpm test:ui запускает тесты с UI.
  • pnpm coverage генерирует отчёт покрытия тестами.