Contribuire ai Samples

Blockly samples contiene contenuti aggiuntivi relativi a Blockly che non fanno parte del repository principale, inclusi plug-in, codelab e codice di esempio. Per maggiori dettagli su ciascuno di questi, consulta la pagina Struttura del repository.

Cose da sapere

Ecco una rapida panoramica dei fatti su blockly-samples che devi conoscere per creare una richiesta di pull.

  • Il ramo di lavoro è main e tutte le PR devono essere create rispetto a main.
  • Esegui npm install a livello di root di blockly-samples, non a livello di singolo plug-in. Blockly-samples è un monorepo, ovvero contiene più pacchetti nello stesso repository e l'installazione a livello di root fa parte del flusso di lavoro per la gestione del monorepo con Lerna.
  • Il codice deve essere conforme alla guida di stile JavaScript di Google o alla guida di stile TypeScript, a seconda del linguaggio utilizzato.
  • Utilizza conventional commits nei messaggi di commit e nei titoli delle richieste di pull.

  • Tutti i nuovi file di codice devono avere come prefisso la licenza Apache v2.0:

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

Apportare e verificare una modifica

  1. Esegui npm install a livello di root di blockly-samples per installare le dipendenze.
  2. Esegui npm run start nella directory di un plug-in per creare e avviare un server che esegue la pagina di test del plug-in. Puoi utilizzare questa pagina per visualizzare il comportamento esistente di un plug-in oppure, se stai aggiungendo un nuovo plug-in, devi renderla una pagina di test utile in modo che gli altri possano vedere cosa fa il tuo plug-in. Per saperne di più, consulta la pagina Playground.
  3. Apporta le modifiche necessarie al codice del plug-in.
  4. Se hai lasciato il server in esecuzione, le modifiche verranno caricate automaticamente. In caso contrario, riavvia il server e verifica che il plug-in si comporti come previsto e che non siano presenti errori o avvisi nella console.
  5. Esegui npm run build e assicurati che non ci siano errori di build.
  6. Scrivi test Mocha automatizzati nella directory test/.
  7. Esegui npm run test per eseguire i test automatici.
  8. Esegui npm run lint:fix per correggere gli errori di lint. Risolvi eventuali avvisi o errori rimanenti.
  9. Esegui npm run format per eseguire il formattatore automatico.
  10. Se tutti i test hanno esito positivo, puoi aprire una richiesta di pull (PR) rispetto a main con le tue modifiche.