Contribuye con Samples

Las muestras de Blockly incluyen contenido adicional relacionado con Blockly que no forma parte del repositorio principal, como complementos, codelabs y código de ejemplo. Para obtener más detalles sobre cada uno de estos, consulta la página Estructura del repositorio.

Información que debes saber

A continuación, se incluye una descripción general rápida de los hechos sobre las muestras de bloques que debes conocer para crear una solicitud de extracción.

  • La rama de trabajo es la principal y todas las solicitudes de PR deben realizarse con la principal.
  • Ejecuta npm install en el nivel raíz de las muestras de blockly, no en el nivel de complemento individual. Blockly-samples es un monorepo, lo que significa que contiene varios paquetes en el mismo repositorio, y la instalación en el nivel raíz es parte del flujo de trabajo para administrar el monorepo con Lerna.
  • El código debe cumplir con la Guía de estilo de JavaScript o la Guía de estilo de TypeScript de Google, según el lenguaje que se use.
  • Usa confirmaciones convencionales en tus mensajes de confirmación y títulos de solicitudes de extracción.

  • Todos 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
 */

Cómo realizar y verificar un cambio

  1. Ejecuta npm install en el nivel raíz de las muestras de bloques para instalar las dependencias.
  2. Ejecuta npm run start en el directorio de un complemento para compilar e iniciar un servidor que ejecute la página de prueba del complemento. Puedes usar esta página para ver el comportamiento existente de un complemento o, si estás agregando un complemento nuevo, deberás hacer que esta sea una página de prueba útil para que otros puedan ver lo que hace tu complemento. Consulta la página de playground para obtener más información.
  3. Realiza los cambios necesarios en el código del complemento.
  4. Si dejaste el servidor ejecutándose, tus cambios se cargarán automáticamente. De lo contrario, reinicia el servidor y verifica que el complemento 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 de Mocha automatizadas en el directorio test/.
  7. Ejecuta npm run test para ejecutar las pruebas automatizadas.
  8. Ejecuta npm run lint:fix para corregir errores de lint. Soluciona cualquier advertencia o error restante.
  9. Ejecuta npm run format para ejecutar el autoformateador.
  10. Si se superan todas las pruebas, estás listo para abrir una solicitud de extracción contra master con tus cambios.