Contribuire al core

Il repository principale di Blockly contiene il codice necessario per eseguire qualsiasi applicazione basata su Blockly.

Cose da sapere

Ecco una rapida panoramica dei fatti principali su Blockly core che devi conoscere per creare una richiesta pull.

  • Il ramo di lavoro è main e tutte le PR devono essere create in base a main.
  • Devi compilare il modello di richiesta di pull con le informazioni richieste.
  • Il codice deve essere conforme alla guida di stile TypeScript di Google.
  • Utilizza conventional commits nei messaggi di commit e nei titoli delle richieste di pull.
  • Le stringhe visibili all'utente devono trovarsi nel file /msg/messages.js in modo che possano essere tradotte. Meno del 6% della popolazione mondiale parla inglese come lingua madre.
  • Il testo sui blocchi deve essere generalmente tutto in minuscolo (proprio come le parole chiave nella maggior parte dei linguaggi di programmazione).
  • Mantenere la compatibilità con le versioni precedenti. Esistono molte app Blockly, non interrompere il funzionamento di tutte le altre.

  • 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 per installare le dipendenze.
  2. Esegui npm run start per avviare un server che esegue il playground. Puoi utilizzare questa pagina per testare il comportamento esistente. Per ulteriori informazioni, consulta la pagina playground.
  3. Apporta le modifiche necessarie al codice.
  4. Se hai lasciato il server in esecuzione, aggiorna per visualizzare le modifiche. In caso contrario, riavvia il server e verifica che il codice 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. Scrivere test automatici. In genere, si tratta di test Mocha nella directory tests/mocha, ma potremmo chiederti altri tipi di test.
  7. Esegui npm run format per formattare il codice e correggere automaticamente alcuni problemi di lint.
  8. Esegui npm test per eseguire i test automatici. Viene eseguito anche eslint.
  9. Se sono presenti errori di lint, esegui npm run lint:fix per risolvere i problemi che possono essere corretti automaticamente. Risolvi eventuali avvisi o errori di lint rimanenti.
  10. Se tutti i test hanno esito positivo, puoi aprire una richiesta di pull (PR) rispetto a main con le tue modifiche.