Contribuir com o Core

O repositório principal do Blockly contém o código necessário para executar qualquer aplicativo baseado em Blockly.

O que é preciso saber

Aqui está uma visão geral rápida dos fatos sobre o núcleo de bloco que você precisa saber para criar um PR.

  • A ramificação de trabalho é develop e todas as PRs precisam ser feitas contra desenvolvimento.
  • Preencha o modelo de solicitação de envio com as informações solicitadas.
  • O código precisa estar em conformidade com o Guia de estilo do TypeScript do Google.
  • Use confirmações convencionais nas mensagens de confirmação e nos títulos das solicitações de envio.
  • As strings visíveis ao usuário precisam estar no arquivo /msg/messages.js para que possam ser traduzidas. Menos de 6% do mundo fala inglês de maneira nativa.
  • O texto nos blocos geralmente deve ser todo em letras minúsculas (assim como as palavras-chave na maioria das linguagens de programação).
  • Manter a compatibilidade com versões anteriores. Há vários apps do Blockly por aí, não prejudique todos os outros.

  • 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 para instalar dependências.
  2. Execute npm run start para iniciar um servidor executando o Playground. Você pode usar esta página para testar o comportamento existente. Consulte a página da playground para mais informações.
  3. Faça as alterações necessárias no código.
  4. Se você deixou o servidor em execução, atualize a página para conferir as alterações. Caso contrário, reinicie o servidor e verifique se o código 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 automatizados. Normalmente, serão testes de mocha no diretório tests/mocha, mas podemos solicitar outros tipos de teste.
  7. Execute npm run format para formatar o código e corrigir automaticamente alguns problemas do lint.
  8. Execute npm test para executar os testes automatizados. Isso também executa eslint.
  9. Se houver erros de lint, execute npm run lint:fix para corrigir os problemas que podem ser corrigidos automaticamente. Resolva os avisos ou erros restantes do lint.
  10. Se todos os testes forem aprovados, você estará pronto para abrir um PR em relação ao develop com suas mudanças.