web configs
@shopify
Este repositório contém configurações comuns para a criação de aplicativos da Web no Shopify.
Este repositório é gerenciado como um monorepo composto por muitos pacotes NPM, onde cada pacote tem seu próprio README e documentação que descreve o uso.
| Nome | Npm | Tamanho |
|---|---|---|
| Babel-Preset | ||
| Navegador-lista de navegação | ||
| Eslint-plugin | ||
| imagens | ||
| POSTCSS-PLUGIN | ||
| Config mais bonito | ||
| Stylelint-plugin | ||
| TypeScript-Configs |
Este repositório possui um CLA-BOT em execução que solicitará aos colaboradores que assinem um Contrato de Licença de Colaborador (CLA).
O Shopify também adotou um código de conduta para o qual esperamos que os contribuintes sigam. Leia o texto completo para que você possa entender quais ações serão e não serão toleradas.
Existem muitas maneiras de contribuir, algumas das quais são:
# 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 é uma ferramenta para padronizar um pequeno conjunto de tarefas comuns em todos os projetos da Shopify. Se você está se perguntando como executar os comandos do dev como um colaborador externo, pode ver onde eles são definidos no arquivo dev.yml deste projeto.
Para experimentar suas alterações em outro projeto clonado localmente, você pode usar yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> . O uso deste comando em vez yarn link configurará um observador permitirá que você faça alterações sem precisar executar remessas com comandos.
Exemplo: Para testar minhas alterações em @shopify/react-form-state no meu projeto local chamado my-project , eu executaria yarn tophat react-form-state ../path/to/my-project .
Mais instruções de uso no comando tophat podem ser encontradas aqui.
Se sua alteração afetar a API pública de quaisquer pacotes dentro deste repositório (ou seja, adicionando ou alterando argumentos a uma função, adicionando uma nova função, alterando o valor de retorno, etc.), verifique se a documentação é atualizada e um Changelog será adicionado para refletir isso. A documentação está nos arquivos README.md de cada pacote. Se for necessária uma documentação adicional, comunique -se por meio de um problema do GitHub.
Os pacotes deste repositório são usados em cenários de produção de missão crítica. Como tal, não mesclamos nenhum código não testado.
Para executar o conjunto de testes completo, basta executar dev test ou yarn test .
Atualmente, o processo de liberação envolve algumas etapas manuais a serem concluídas. Depois que seu PR for mesclado, nossa equipe orquestrará quando cortar um novo lançamento.
Nota Os números da versão nos arquivos package.json nunca devem ser alterados manualmente. Isso será feito via scripts como parte do processo de liberação.
MIT © Shopify, consulte License.md para obter detalhes.
