Contribuire al core

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

Cose da sapere

Ecco una breve panoramica degli aspetti di Blockly Core che devi conoscere per creare una PR.

  • Il ramo di lavoro è develop e tutte le PR devono essere effettuate rispetto a develop.
  • Devi compilare il modello di richiesta di pull con le informazioni richieste.
  • Il codice deve essere conforme alle linee guida di stile per TypeScript di Google.
  • Utilizza i commit convenzionali nei messaggi dei commit e nei titoli delle richieste pull.
  • Le stringhe visibili all'utente devono trovarsi nel file /msg/messages.js per poter essere tradotte. Meno del 6% della popolazione mondiale parla inglese come lingua madre.
  • In genere, il testo nei blocchi deve essere 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 rovinare quelle degli altri.

  • Tutti i nuovi file di codice devono avere il prefisso della Licenza Apache 2.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 su cui è in esecuzione 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 funzioni come previsto e che non siano presenti errori o avvisi nella console.
  5. Esegui npm run build e assicurati che non siano presenti errori di compilazione.
  6. Scrivere test automatici. In genere, si tratta di test mocha nella directorytests/mocha, ma potremmo chiederti altri tipi di test.
  7. Esegui npm run format per formattare il codice e correggere automaticamente alcuni problemi lint.
  8. Esegui npm test per eseguire i test automatici. Viene eseguito anche eslint.
  9. Se sono presenti errori lint, esegui npm run lint:fix per correggere i problemi che possono essere corretti automaticamente. Risolvi eventuali avvisi o errori di lint rimanenti.
  10. Se tutti i test sono stati superati, puoi aprire una PR contro develop con le modifiche.