web configs

Web構成

このリポジトリには、ShopifyにWebアプリを構築するための一般的な構成が含まれています。

使用法

このレポは、多くのNPMパッケージで構成されるモノレポとして管理されています。各パッケージには、使用法を説明する独自のREADMEとドキュメントがあります。

パッケージインデックス

名前	npm	サイズ
バベルプレセット
browserSlist-config
Eslint-Plugin
画像
postcss-plugin
PrettierConfig
stylelint-plugin
TypeScript-configs

貢献

このリポジトリには、貢献者に貢献者ライセンス契約（CLA）に署名するように依頼するCLA-BOTランニングがあります。

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を実行するだけです。

リリース

現在、リリースプロセスには、完了するための手動の手順が含まれています。 PRが合併されると、私たちのチームは新しいリリースをカットするタイミングを組織します。

package.jsonファイルのバージョン番号を手動で変更しないでください。これは、リリースプロセスの一部としてスクリプトを介して行われます。

ライセンス

MIT©Shopify、詳細については、license.mdを参照してください。