web configs
@shopify
Этот репозиторий содержит общие конфигурации для создания веб -приложений в Shopify.
Это репо управляется как монорепо, состоит из многих пакетов NPM, где каждый пакет имеет свою собственную README и документацию, описывающую использование.
| Имя | Npm | Размер |
|---|---|---|
| Вавилон-президент | ||
| Browserslist-Config | ||
| Eslint-Plugin | ||
| изображения | ||
| postcss-plugin | ||
| Краткий конфиг | ||
| StyleLelint-Plugin | ||
| TypeScript-Configs |
Этот репозиторий имеет работу CLA-Bot, который попросит участников подписать лицензионное соглашение о участнике (CLA).
Shopify также принял кодекс поведения, которому мы ожидаем придерживаться участников. Пожалуйста, прочитайте полный текст, чтобы вы могли понять, какие действия будут и не будут терпеть.
Есть много способов внести свой вклад, некоторые из которых:
# Shopify Employee
dev clone web-configs
dev up
# External Contributor - To start working on the codebase, first fork the repo, then clone it
git clone [email protected]:{your-username}/web-configs.git # replace {your-username} with your GitHub handle
yarn # install project dependencies dev ? dev - это инструмент для стандартизации небольшого набора общих задач по всем проектам в Shopify. Если вам интересно, как выполнить команды DEV в качестве внешнего участника, вы можете увидеть, где они определены в файле dev.yml этого проекта.
Чтобы попробовать свои изменения в другом локально клонированном проекте, вы можете использовать yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> . Использование этой команды, а не yarn link настраивает наблюдатель, позволяя вам вносить изменения без необходимости повторного запуска каких -либо команд.
Пример: чтобы проверить мои изменения в @shopify/react-form-state в моем локальном проекте под названием my-project , я бы запустил yarn tophat react-form-state ../path/to/my-project .
Больше инструкций по использованию по команде tophat можно найти здесь.
Если ваше изменение влияет на публичный API любого пакета в этом репозитории (то есть добавление или изменение аргументов в функцию, добавление новой функции, изменение возврата значения и т. Д.) Убедитесь, что документация обновляется, и добавляется изменяющаяся изменение. Документация находится в файлах README.md каждого пакета. Если необходима дальнейшая документация, пожалуйста, сообщите с помощью выпуска GitHub.
Пакеты в этом репозитории используются в критически важных сценариях производства. Таким образом, мы не объединяем непроверенный код.
Чтобы запустить полный набор тестов, просто запустите dev test или yarn test .
Процесс выпуска в настоящее время включает в себя некоторые ручные шаги для завершения. Как только ваш PR будет объединен, наша команда будет организовать, когда вырезать новый релиз.
Номера версий примечания в файлах package.json никогда не должны изменяться вручную. Это будет сделано через сценарии как часть процесса выпуска.
MIT © Shopify, см. License.md для получения подробной информации.
