Contribuir com Samples

O Blockly Samples contém conteúdo extra relacionado ao Blockly que não faz parte do repositório principal, incluindo plug-ins, codelabs e código de exemplo. Para mais detalhes sobre cada um deles, consulte a página Estrutura do repositório.

O que é preciso saber

Aqui está uma visão geral rápida dos fatos sobre amostras em bloco que você precisa conhecer para criar um PR.

  • O branch de trabalho é master, e todos os PRs devem ser feitos em relação ao mestre.
  • Execute npm install na raiz de blockly-samples, não no nível do plug-in individual. O Blockly-samples é um monorepo, ou seja, contém vários pacotes no mesmo repositório. A instalação no nível raiz faz parte do fluxo de trabalho para gerenciar o monorepo com o Lerna.
  • O código precisa estar em conformidade com o Guia de estilo do JavaScript ou do TypeScript do Google, dependendo da linguagem usada.
  • Use confirmações convencionais nas mensagens de confirmação e nos títulos das solicitações de envio.

  • Todos os novos arquivos de código precisam ser prefixados com a Licença Apache v2.0:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

Fazer e verificar uma mudança

  1. Execute npm install no nível raiz de blockly-samples para instalar dependências.
  2. Execute npm run start no diretório de um plug-in para criar e iniciar um servidor que executa a página de teste do plug-in. Você pode usar essa página para ver o comportamento existente de um plug-in. Se estiver adicionando um novo plug-in, será necessário tornar essa página de teste útil para que outras pessoas possam ver o que seu plug-in faz. Consulte a página da playground para mais informações.
  3. Faça as alterações necessárias no código do plug-in.
  4. Se você tiver deixado o servidor em execução, as suas alterações serão carregadas automaticamente. Caso contrário, reinicie o servidor e verifique se o plug-in se comporta como esperado e se não há erros ou avisos no console.
  5. Execute npm run build e verifique se não há erros de build.
  6. Crie testes mocha automatizados no diretório test/.
  7. Execute npm run test para executar os testes automatizados.
  8. Execute npm run lint:fix para corrigir erros de lint Resolva os avisos ou erros restantes.
  9. Execute npm run format para executar o autoformatador.
  10. Se todos os testes forem aprovados, você estará pronto para abrir um PR em relação ao master com suas alterações.