Contribuer au noyau

Le dépôt principal Blockly contient le code nécessaire pour exécuter n'importe quelle application basée sur Blockly.

À savoir

Voici un bref aperçu des informations importantes à connaître sur le cœur de Blockly pour créer une demande d'extraction.

  • La branche de travail est main et toutes les demandes d'extraction doivent être effectuées par rapport à main.
  • Vous devez remplir le modèle de demande d'extraction en fournissant les informations demandées.
  • Le code doit être conforme au guide de style TypeScript de Google.
  • Utilisez des commits conventionnels dans vos messages de commit et les titres de vos demandes d'extraction.
  • Les chaînes visibles par l'utilisateur doivent figurer dans le fichier /msg/messages.js pour pouvoir être traduites. Moins de 6 % de la population mondiale parle anglais comme langue maternelle.
  • Le texte des blocs doit généralement être en minuscules (comme les mots clés dans la plupart des langages de programmation).
  • Maintenir la rétrocompatibilité. Il existe de nombreuses applications Blockly. Ne les cassez pas toutes.

  • Tout nouveau fichier de code doit être précédé de la licence Apache 2.0 :

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

Effectuer et vérifier une modification

  1. Exécutez npm install pour installer les dépendances.
  2. Exécutez npm run start pour démarrer un serveur exécutant le terrain de jeu. Vous pouvez utiliser cette page pour tester le comportement existant. Pour en savoir plus, consultez la page Bac à sable.
  3. Apportez les modifications nécessaires au code.
  4. Si vous avez laissé le serveur en cours d'exécution, actualisez la page pour voir vos modifications. Sinon, redémarrez le serveur et vérifiez que le code se comporte comme prévu et qu'il n'y a pas d'erreurs ni d'avertissements dans la console.
  5. Exécutez npm run build et assurez-vous qu'il n'y a pas d'erreurs de compilation.
  6. Écrivez des tests automatisés. Il s'agit généralement de tests Mocha dans le répertoire tests/mocha, mais nous pouvons vous demander d'autres types de tests.
  7. Exécutez npm run format pour mettre en forme le code et corriger automatiquement certains problèmes de lint.
  8. Exécutez npm test pour exécuter les tests automatisés. Cela exécute également eslint.
  9. En cas d'erreurs lint, exécutez npm run lint:fix pour résoudre les problèmes pouvant être corrigés automatiquement. Corrigez les avertissements ou erreurs Lint restants.
  10. Si tous les tests réussissent, vous pouvez ouvrir une demande d'extraction par rapport à main avec vos modifications.