Cómo contribuir al núcleo

El repositorio principal de Blockly contiene el código necesario para ejecutar cualquier aplicación basada en Blockly.

Información importante

A continuación, se incluye una breve descripción general de los datos sobre el núcleo de Blockly que debes saber para crear una PR.

  • La rama de trabajo es develop y todas las PR deben realizarse en función de esta.
  • Debes completar la plantilla de solicitud de extracción con la información solicitada.
  • El código debe cumplir con la Guía de estilo de TypeScript de Google.
  • Usa confirmaciones convencionales en los mensajes de confirmación y los títulos de las solicitudes de extracción.
  • Las cadenas visibles para el usuario deben estar en el archivo /msg/messages.js para que se puedan traducir. Menos del 6% de la población mundial habla inglés como idioma nativo.
  • Por lo general, el texto de los bloques debe estar en minúsculas (al igual que las palabras clave en la mayoría de los lenguajes de programación).
  • Mantén la retrocompatibilidad. Hay muchas apps de Blockly, no las rompas.

  • Los archivos de código nuevos deben tener el prefijo de la Licencia Apache v2.0:

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

Realiza y verifica un cambio

  1. Ejecuta npm install para instalar las dependencias.
  2. Ejecuta npm run start para iniciar un servidor que ejecute el campo de pruebas. Puedes usar esta página para probar el comportamiento existente. Consulta la página playground para obtener más información.
  3. Realiza los cambios necesarios en el código.
  4. Si dejaste el servidor en ejecución, actualízalo para ver los cambios. De lo contrario, reinicia el servidor y verifica que el código se comporte como se espera y que no haya errores ni advertencias en la consola.
  5. Ejecuta npm run build y asegúrate de que no haya errores de compilación.
  6. Escribe pruebas automatizadas. Por lo general, estas serán pruebas de Mocha en el directorio tests/mocha, pero es posible que te solicitemos otros tipos de pruebas.
  7. Ejecuta npm run format para dar formato al código y corregir automáticamente algunos problemas de lint.
  8. Ejecuta npm test para ejecutar las pruebas automatizadas. Esto también ejecuta eslint.
  9. Si hay errores de lint, ejecuta npm run lint:fix para corregir los problemas que se pueden corregir automáticamente. Soluciona las advertencias o los errores de lint restantes.
  10. Si se superan todas las pruebas, puedes abrir una solicitud de cambios en develop con tus cambios.