Dai il tuo contributo 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 ulteriori dettagli su ciascuna di queste opzioni, consulta la pagina Struttura del repository.

Cose da sapere

Ecco una breve panoramica delle informazioni sugli esempi di blockly che devi conoscere per creare un PR.

  • Il ramo operativo è master e tutte le PR devono essere effettuate rispetto al master.
  • Esegui npm install al livello principale degli esempi blockly, non a livello del singolo plug-in. Blockly-samples è un monorepo, ovvero contiene più pacchetti nello stesso repository, e l'installazione a livello principale fa parte del flusso di lavoro per la gestione del monorepo con Lerna.
  • Il codice deve essere conforme alla Guida di stile JavaScript o alla Guida di stile TypeScript di Google a seconda della lingua utilizzata.
  • Utilizza i commissioni convenzionali nei messaggi di commit e i titoli delle richieste di pull.

  • Ogni nuovo file di codice deve essere preceduto da Apache License v2.0:

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

Apporta e verifica una modifica

  1. Esegui npm install al livello principale degli esempi blockly 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 vedere il comportamento esistente di un plug-in o, se vuoi aggiungere un nuovo plug-in, dovrai renderlo un'utile pagina di test in modo che gli altri possano vedere la funzione del plug-in. Consulta la pagina relativa al playground per ulteriori informazioni.
  3. Apporta le modifiche necessarie al codice del plug-in.
  4. Se hai lasciato in esecuzione il server, le modifiche verranno caricate automaticamente. In caso contrario, riavvia il server e verifica che il plug-in funzioni 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 automatici 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 un PR contro il master con le tue modifiche.