web configs

Web配置

该存储库包含用于在Shopify上构建Web应用程序的常见配置。

用法

该存储库被视为由许多NPM软件包组成的MonorePo，每个软件包都有其自己的README和文档描述用法。

软件包索引

姓名	NPM	尺寸
babel-preset
browserslist-config
Eslint-Plugin
图像
PostCSS-Plugin
漂亮的config
Stylelint-Plugin
打字稿configs

贡献

该存储库有一个CLA机器人运行，它将要求贡献者签署贡献者许可协议（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将设置一个观察者，让您进行更改而无需重新运行任何命令。

示例：为了在my-project本地项目中测试我对@shopify/react-form-state的更改，我将运行yarn tophat react-form-state ../path/to/my-project 。

可以在此处找到有关tophat命令的更多用法说明。

文档

如果您的更改会影响此存储库中任何软件包的公共API（即将参数添加或更改为函数，添加新功能，更改返回值等），请确保更新文档，并添加更改程序以反映这一点。文档位于每个软件包的README.md文件中。如果需要进一步的文档，请通过GitHub问题进行通信。

测试

该存储库中的包装用于关键任务生产方案。因此，我们不合并任何未经测试的代码。

要运行完整的测试套件，只需运行dev test或yarn test即可。

释放

目前，发布过程涉及一些手动步骤要完成。一旦您的公关合并，我们的团队将何时策划新版本。

注意package.json中的版本号。json文件绝不应手动更改。这将通过脚本作为发行过程的一部分完成。

执照

麻省理工学院©Shopify，有关详细信息，请参见License.MD。