web configs
@shopify
Este repositorio contiene configuraciones comunes para crear aplicaciones web en Shopify.
Este repositorio se gestiona como un monorepo compuesto por muchos paquetes de NPM, donde cada paquete tiene su propio README y documentación que describe el uso.
| Nombre | Npm | Tamaño |
|---|---|---|
| presagio de babel | ||
| navegador | ||
| Eslint-Plugin | ||
| imágenes | ||
| postcss-plugin | ||
| más bonito | ||
| stylelint-plugin | ||
| configs de mecanografiado |
Este repositorio tiene un botón CLA que le pedirá a los contribuyentes que firmen un Acuerdo de licencia de contribuyente (CLA).
Shopify también ha adoptado un código de conducta al que esperamos que los contribuyentes se adhieran. Lea el texto completo para que pueda comprender qué acciones serán y no serán toleradas.
Hay muchas formas de contribuir, algunas de las cuales son:
# 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 es una herramienta para estandarizar un pequeño conjunto de tareas comunes en todos los proyectos de Shopify. Si se pregunta cómo ejecutar los comandos de desarrollo como un contribuyente externo, puede ver dónde se definen en el archivo dev.yml de este proyecto.
Para probar sus cambios en otro proyecto clonado localmente, puede usar yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> . Usar este comando en lugar yarn link configurará un observador le permitirá hacer cambios sin necesidad de volver a ejecutar ningún comando.
Ejemplo: para probar mis cambios en @shopify/react-form-state en mi proyecto local llamado my-project , ejecutaría yarn tophat react-form-state ../path/to/my-project .
Aquí se pueden encontrar más instrucciones de uso en el comando tophat aquí.
Si su cambio afecta a la API pública de cualquier paquete dentro de este repositorio (es decir, agregar o cambiar los argumentos a una función, agregar una nueva función, cambiar el valor de retorno, etc.), asegúrese de actualizar la documentación y se agrega un CangeLog para reflejar esto. La documentación está en los archivos README.md de cada paquete. Si se necesita más documentación, comuníquese a través de un problema de GitHub.
Los paquetes en este repositorio se utilizan en escenarios de producción de misión crítica. Como tal, no fusionamos ningún código no probado.
Para ejecutar el suite de prueba completo, simplemente ejecute dev test o yarn test .
El proceso de lanzamiento actualmente implica algunos pasos manuales para completar. Una vez que su PR se haya fusionado, nuestro equipo orquestará cuándo recortar un nuevo lanzamiento.
Nota Los números de versión en los archivos package.json nunca deben modificarse manualmente. Esto se realizará a través de scripts como parte del proceso de lanzamiento.
MIT © Shopify, consulte Licencia.md para más detalles.
