web configs
@shopify
Dieses Repository enthält gemeinsame Konfigurationen zum Erstellen von Web -Apps bei Shopify.
Dieses Repo wird als Monorepo verwaltet, das aus vielen NPM -Paketen besteht, in denen jedes Paket seine eigene README und Dokumentation enthält, in der die Verwendung beschrieben wird.
| Name | NPM | Größe |
|---|---|---|
| Babel-Preset | ||
| Browserlist-Config | ||
| Eslint-Plugin | ||
| Bilder | ||
| Postcss-Plugin | ||
| Schöner-Konfiguration | ||
| Stylelint-Plugin | ||
| Typscript-Configs |
Dieses Repository hat einen CLA-BOT, der die Mitwirkenden auffordert, eine Mitarbeiterin Lizenzvereinbarung (CLA) zu unterzeichnen.
Shopify hat außerdem einen Verhaltenskodex angenommen, den wir erwarten, an dem wir die Mitwirkenden halten. Bitte lesen Sie den vollständigen Text, damit Sie verstehen können, welche Aktionen nicht toleriert werden.
Es gibt viele Möglichkeiten, einen Beitrag zu leisten, von denen einige sind:
# 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 ist ein Werkzeug, um eine kleine Reihe gemeinsamer Aufgaben in allen Projekten bei Shopify zu standardisieren. Wenn Sie sich fragen, wie Sie die Entwicklerbefehle als externen Mitwirkenden ausführen, können Sie sehen, wo sie in der dev.yml -Datei dieses Projekts definiert sind.
Um Ihre Änderungen in einem anderen lokal geklonten Projekt auszuprobieren, können Sie yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> verwenden. Wenn Sie diesen Befehl anstelle von yarn link verwenden, können Sie Änderungen vornehmen, ohne dass Befehle erneut ausgelöst werden müssen.
Beispiel: Um meine Änderungen an @shopify/react-form-state in meinem lokalen Projekt namens my-project zu testen, würde ich yarn tophat react-form-state ../path/to/my-project .
Weitere Verwendungsanweisungen im Befehl tophat finden Sie hier.
Wenn sich Ihre Änderung auf die öffentliche API von Paketen in diesem Repository auswirkt (dh Hinzufügen oder Ändern von Argumenten zu einer Funktion, Hinzufügen einer neuen Funktion, Änderung des Rückgabewerts usw.), stellen Sie sicher, dass die Dokumentation aktualisiert wird und ein Changelog hinzugefügt wird, um dies widerzuspiegeln. Die Dokumentation befindet sich in den README.md -Dateien jedes Pakets. Wenn weitere Unterlagen erforderlich sind, kommunizieren Sie bitte über ein Github -Problem.
Die Pakete in diesem Repository werden in missionskritischen Produktionsszenarien verwendet. Als solches verschmelzen wir keinen ungetesteten Code.
Um die vollständige Testsuite auszuführen, führen Sie einfach dev test oder yarn test durch.
Der Freigabevorgang umfasst derzeit einige manuelle Schritte, die auszuführen sind. Sobald Ihre PR zusammengeführt wurde, wird unser Team eine neue Veröffentlichung abschneiden.
Hinweisversionsnummern in package.json -Dateien sollten niemals manuell geändert werden. Dies erfolgt über Skripte als Teil des Veröffentlichungsprozesses.
MIT © Shopify, siehe Lizenz.MD für Details.
