Contribuir com amostras

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 dos fatos sobre o blockly-samples que você precisa saber para criar uma solicitação de pull.

  • A ramificação de trabalho é main, e todos os PRs precisam ser feitos 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 de acordo com o Guia de estilo JavaScript ou o Guia de estilo TypeScript, dependendo do idioma usado.
  • Use commits convencionais nas mensagens de commit e nos títulos de solicitações de pull.

  • 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 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 execute a página de teste do plug-in. Use essa página para conferir o comportamento atual de um plug-in. Se você estiver adicionando um novo, crie uma página de teste útil para que outras pessoas possam ver o que ele faz. Consulte a página do 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 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. Escreva 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 formatador automático.
  10. Se todos os testes forem aprovados, você poderá abrir uma solicitação de pull em main com suas mudanças.