Вклад в проект

Как внести свой вклад

Мы приветствуем ваш вклад в репозиторий через форк и отправку пул реквеста.

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

(Если вы новичок в GitHub, вы можете начать с базового туториала и ознакомиться с более подробным руководством по пул реквестам.)

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

Вклады делаются в соответствии с Сертификатом происхождения разработчика, доступным по адресу https://developercertificate.org, и лицензированы под Apache License, версия 2.0 (Apache-2.0).

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

Пакеты в этом репозитории управляются с помощью yarn workspaces и release-please. Чтобы создать новый пакет, проще всего скопировать один из существующих пакетов в каталоге packages и удалить и переименовать всё, что не нужно.

Некоторые общие замечания по созданию нового пакета:

• Исходные файлы должны быть размещены в каталоге packages/<package-name>/src.
• Тестовые файлы, которые тестируют несколько функций, должны быть размещены в каталоге packages/<package-name>/tests.
• Если вы хотите включить образцы файлов для своего пакета, вы можете разместить их в каталоге packages/<package-name>/samples.
• Убедитесь, что вы обновили все ссылки на имена пакетов в файлах package.json, README.md.
• Удалите файл CHANGELOG.md. Он будет автоматически добавлен release-please.
• Убедитесь, что ваш пакет включает все необходимые файлы сборки:
  • jest.config.ts
  • tsconfig.json
  • tsconfig.build.json

Процесс выпуска

Релизы управляются с помощью Release Please. Он автоматически сканирует все коммиты, используя стандартные обычные коммиты. Если обнаружены изменения, которые вызовут повышение версии с использованием области feat: или fix:, или ! (например, feat!:) для критических изменений, release please откроет PR с повышением версии и обновлениями в CHANGELOG.md. PR будет автоматически поддерживаться в актуальном состоянии, и после его слияния будет создан новый релиз на Github, а пакет будет выпущен на NPM.

См. этот PR для примера. Каждый пакет имеет свою версию, чтобы пакеты могли развиваться в своём собственном темпе. Чтобы сделать процесс выпуска максимально гладким, убедитесь, что вы следуете этим рекомендациям:

• Убедитесь, что ваши коммиты соответствуют спецификации Conventional Commits.
  • Если вы хотите сжать свой PR, только заголовок PR должен соответствовать обычным коммитам.
  • Если вы хотите перебазировать свой PR, ВСЕ сообщения коммитов должны соответствовать спецификации обычных коммитов. Это хороший вариант для PR, которые вносят много изменений, которые нельзя отразить в одном сообщении.
• Используйте области, чтобы указать пакет, который затрагивает коммит.
  • Например, если вы добавляете новую функцию в пакет redux-store, начните свой коммит с feat(redux-store): .
• Укажите критические изменения с помощью !.
  • Например, если вы добавляете новую критическую функцию в пакет redux-store, начните свой коммит с feat(redux-store)!: .
• Если вы работаете над несколькими пакетами в одном PR, убедитесь, что разделили коммиты и используете стратегию перебазирования. Сообщение коммита будет применено ко всем пакетам, на которые оно влияет, что означает, что все пакеты получат одинаковое повышение версии.