Contribuir com o núcleo

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

O que você precisa saber

Confira uma visão geral rápida dos fatos sobre o núcleo do Blockly 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 main.
  • 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 commits convencionais nas mensagens de commit e nos títulos de solicitações de pull.
  • As strings visíveis ao usuário precisam estar no arquivo /msg/messages.js para que possam ser traduzidas. Menos de 6% da população mundial fala inglês como língua nativa.
  • O texto nos blocos geralmente precisa estar 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á muitos apps do Blockly por aí. Não estrague a experiência de todo mundo.

  • 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 para instalar dependências.
  2. Execute npm run start para iniciar um servidor que executa o playground. Use esta página para testar o comportamento atual. Consulte a página do playground para mais informações.
  3. Faça as mudanças necessárias no código.
  4. Se você deixou o servidor em execução, atualize para ver as mudanças. Caso contrário, reinicie o servidor e verifique se o código se comporta conforme o 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. Escrever testes automatizados. Normalmente, esses são testes do Mocha no diretório tests/mocha, mas podemos pedir outros tipos de testes.
  7. Execute npm run format para formatar o código e corrigir automaticamente alguns problemas de 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. Corrija os avisos ou erros restantes do lint.
  10. Se todos os testes forem aprovados, você poderá abrir uma solicitação de pull em main com suas mudanças.