Cómo contribuir a las muestras

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 estos, consulta la página Estructura del repositorio.

Información importante

A continuación, se incluye una descripción general rápida de los datos sobre blockly-samples que debes conocer para crear una PR.

  • La rama de trabajo es main y todas las PR deben realizarse en main.
  • Ejecuta npm install en el nivel raíz de blockly-samples,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 de la 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 commits convencionales en los mensajes de commit y los títulos de las 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
 */

Realiza y verifica un cambio

  1. Ejecuta npm install en el nivel raíz de blockly-samples para instalar las dependencias.
  2. Ejecuta npm run start en el directorio de un complemento para compilar y, luego, 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 un complemento nuevo, deberás convertirla en una página de prueba útil para que otros puedan ver lo que hace tu complemento. Consulta la página de zona 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 según lo esperado 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 los errores de lint. Aborda las advertencias o los errores restantes.
  9. Ejecuta npm run format para ejecutar el formateador automático.
  10. Si se superan todas las pruebas, puedes abrir una PR en main con tus cambios.