Contribuer aux ressources principales

Le dépôt principal Blockly contient le code nécessaire à l'exécution des applications basées sur Blockly.

À savoir

Voici un aperçu rapide des faits sur les éléments essentiels par blocs que vous devez connaître pour créer une demande d'extraction.

  • La branche de travail est develop et toutes les demandes d'extraction doivent être effectuées par rapport au développement.
  • Vous devez fournir les informations demandées dans le modèle de demande d'extraction.
  • Le code doit être conforme au 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 pour pouvoir être traduites. Moins de 6% de la population mondiale parle anglais de langue maternelle.
  • Le texte des blocs doit généralement être entièrement en minuscules (comme les mots clés dans la plupart des langages de programmation).
  • assurer la rétrocompatibilité ; Il existe de nombreuses applications Blockly. N'encombrez pas tout le monde.

  • Tous les nouveaux fichiers de code doivent être précédés de la licence Apache v2.0:

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

Effectuer et valider 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 le serveur reste en cours d'exécution, actualisez la page pour afficher les modifications. Sinon, redémarrez le serveur et vérifiez que le code se comporte comme prévu et qu'aucune erreur ni aucun avertissement ne s'affichent 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 En général, il s'agit de tests mocha dans le répertoire tests/mocha, mais nous pouvons vous demander d'effectuer d'autres types de tests.
  7. Exécutez npm run format pour mettre en forme le code et corriger automatiquement certains problèmes lint.
  8. Exécutez npm test pour exécuter les tests automatisés. Cette opération exécute également eslint.
  9. En cas d'erreurs lint, exécutez npm run lint:fix pour résoudre les problèmes qui peuvent être résolus automatiquement. Corrigez les erreurs ou les avertissements lint restants.
  10. Si tous les tests sont concluants, vous êtes prêt à ouvrir une demande de relations publiques concernant le développement avec vos modifications.