web configs
@shopify
Ce référentiel contient des configurations communes pour la création d'applications Web chez Shopify.
Ce repo est géré comme un monorepo composé de nombreux packages NPM, où chaque package a sa propre README et sa documentation décrivant l'utilisation.
| Nom | NPM | Taille |
|---|---|---|
| babel | ||
| Browserslist-Config | ||
| Eslint-Plugin | ||
| images | ||
| Postcss-Plugin | ||
| plus joli | ||
| Stylelint-Plugin | ||
| dactylographe-configs |
Ce référentiel a une course CLA-BOT qui demandera aux contributeurs de signer un accord de licence de contributeur (CLA).
Shopify a également adopté un code de conduite auquel nous nous attendons à adhérer. Veuillez lire le texte intégral afin que vous puissiez comprendre quelles actions seront et ne seront pas tolérées.
Il existe de nombreuses façons de contribuer, dont certaines sont:
# 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 est un outil pour normaliser un petit ensemble de tâches courantes dans tous les projets de Shopify. Si vous vous demandez comment exécuter les commandes Dev en tant que contributeur externe, vous pouvez voir où ils sont définis dans le fichier dev.yml de ce projet.
Pour essayer vos modifications dans un autre projet cloné localement, vous pouvez utiliser yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> . L'utilisation de cette commande plutôt que yarn link metra en place un observateur vous permettra d'apporter des modifications sans avoir besoin de relancer les commandes.
Exemple: Pour tester mes modifications à @shopify/react-form-state dans mon projet local nommé my-project , je ferais l'exécution yarn tophat react-form-state ../path/to/my-project .
Plus d'instructions d'utilisation sur la commande tophat peuvent être trouvées ici.
Si votre modification affecte l'API publique de tous les packages de ce référentiel (c'est-à-dire en ajoutant ou en modifiant les arguments à une fonction, en ajoutant une nouvelle fonction, en modifiant la valeur de retour, etc.), veuillez vous assurer que la documentation est mise à jour et qu'un modiage est ajouté pour refléter cela. La documentation est dans les fichiers README.md de chaque package. Si une documentation supplémentaire est nécessaire, veuillez communiquer via un problème GitHub.
Les packages de ce référentiel sont utilisés dans les scénarios de production critiques. En tant que tel, nous ne fusionnons aucun code non testé.
Pour exécuter la suite de test complète, exécutez simplement dev test ou yarn test .
Le processus de publication implique actuellement certaines étapes manuelles à terminer. Une fois que votre RP a été fusionné, notre équipe sera orchestrée quand couper une nouvelle version.
Remarque Les numéros de version dans package.json Les fichiers ne doivent jamais être modifiés manuellement. Cela se fera via des scripts dans le cadre du processus de version.
MIT © Shopify, voir Licence.md pour plus de détails.
