Contribuye con Samples

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

Información importante

A continuación, se muestra una breve descripción general de los datos sobre blockly-samples que debes conocer para crear una PR.

  • La rama de trabajo es master y todas las PR deben realizarse en master.
  • Ejecuta npm install en el nivel raíz de las muestras en bloque, no en el nivel del complemento individual. Blockly-samples es un monorepo, lo que significa que contiene varios paquetes en el mismo repositorio, y la instalación a 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 los mensajes de confirmación y los títulos de las solicitudes de extracción.
  • 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 a nivel de raíz de blockly-samples 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 agregas uno nuevo, deberás hacer que esta sea una página de prueba útil para que otras personas puedan ver lo que hace. Consulta la página del campo de pruebas para obtener más información.
  3. Realiza los cambios necesarios en el código del complemento.
  4. Si dejaste el servidor en ejecución, los 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 automatizadas de Mocha 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 las advertencias o los errores que queden.
  9. Ejecuta npm run format para ejecutar el autoformateador.
  10. Si se superan todas las pruebas, puedes abrir una solicitud de cambios en master con tus cambios.