Contribuer aux ressources principales

Le dépôt principal de 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 que vous devez connaître sur les blocs blockly pour créer une RP.

  • La branche qui fonctionne est develop et tous les PR doivent être réalisés contre "develop".
  • Vous devez remplir le modèle de demande d'extraction avec les informations demandées.
  • Le code doit respecter le guide de style TypeScript de Google.
  • Utilisez des commits classiques dans vos messages de commit et vos titres de demandes d'extraction.
  • Les chaînes visibles par l'utilisateur doivent se trouver dans le fichier /msg/messages.js afin qu'elles puissent être traduites. Moins de 6% de la population mondiale parle anglais en tant que langue maternelle.
  • Le texte des blocs doit généralement être tout en minuscules (tout comme les mots clés dans la plupart des langages de programmation).
  • Assurez la rétrocompatibilité. Il existe beaucoup d'applications Blockly. Ne faites pas planter les autres.

  • 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 Playground. Vous pouvez utiliser cette page pour tester le comportement existant. Pour en savoir plus, consultez la page Playground.
  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. Écrire 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. Cette commande exécute également eslint.
  9. En cas d'erreurs lint, exécutez npm run lint:fix pour corriger les problèmes pouvant être corrigés automatiquement. Résolvez les avertissements ou erreurs de lint restants.
  10. Si tous les tests réussissent, vous êtes prêt à ouvrir un PR pour develop avec vos modifications.