Contribuir com Samples

Exemplos do Blockly (link em inglês) contém conteúdo extra relacionado ao Blockly que não faz parte do repositório principal, incluindo plug-ins, codelabs e exemplos de código. Para mais detalhes sobre cada um deles, consulte a página Estrutura do repositório.

O que você precisa saber

Confira uma visão geral rápida de fatos sobre o blockly-samples que você precisa saber para criar um PR.

  • A ramificação de trabalho é master, e todas as PRs precisam ser feitas em relação a ela.
  • Execute npm install no nível raiz de blockly-samples, não no nível do plug-in individual. O Blockly-samples é um monorepo, ou seja, ele contém vários pacotes no mesmo repositório, e 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 JavaScript ou o guia de estilo TypeScript do Google, dependendo da linguagem usada.
  • Use confirmações convencionais nas mensagens de confirmação e nos títulos de solicitações de envio.

  • Todos os novos arquivos de código precisam ter o prefixo da 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 do 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 execute a página de teste do plug-in. Você pode usar essa página para conferir o comportamento de um plug-in ou, se estiver adicionando um novo plug-in, precisará fazer com que ela seja uma página de teste útil para que outras pessoas possam conferir o que o plug-in faz. Consulte a página playground para mais informações.
  3. Faça as mudanças necessárias no código do plug-in.
  4. Se você deixou o servidor em execução, as mudanças serão carregadas automaticamente. Caso contrário, reinicie o servidor e verifique se o plug-in se comporta conforme o esperado e 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 automatizados do Mocha 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ê poderá abrir uma PR com as mudanças no master.