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。