Contribuer aux Samples

Exemples Blockly contient du contenu supplémentaire lié à Blockly qui ne fait pas partie du dépôt principal, y compris des plug-ins, des ateliers de programmation et des exemples de code. Pour en savoir plus sur chacun d'eux, consultez la page Structure du dépôt.

À savoir

Voici un bref aperçu des faits à connaître concernant les échantillons par blocs pour créer un PR.

  • La branche de travail est master, et toutes les PR doivent être créées sur cette branche.
  • Exécutez npm install au niveau racine de blockly-samples, et non au niveau de chaque plug-in. Blockly-samples est un dépôt monodépôt, ce qui signifie qu'il contient plusieurs packages dans le même dépôt. L'installation au niveau racine fait partie du workflow de gestion du monodépôt avec Lerna.
  • Le code doit respecter le guide de style JavaScript ou le guide de style TypeScript de Google, en fonction du langage utilisé.
  • Utilisez des commits conventionnels dans vos messages de commit et les titres de vos requêtes pull.

  • Tout nouveau fichier de code doit avoir le préfixe de la licence Apache v2.0:

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

Effectuer et vérifier une modification

  1. Exécutez npm install au niveau racine de blockly-samples pour installer les dépendances.
  2. Exécutez npm run start dans le répertoire d'un plug-in pour créer et démarrer un serveur exécutant la page de test du plug-in. Vous pouvez utiliser cette page pour voir le comportement existant d'un plug-in. Si vous ajoutez un nouveau plug-in, vous devrez en faire une page de test utile afin que d'autres utilisateurs puissent voir ce que votre plug-in fait. Pour en savoir plus, consultez la page Playground.
  3. Apportez les modifications nécessaires au code du plug-in.
  4. Si vous n'avez pas arrêté le serveur, vos modifications seront chargées automatiquement. Dans le cas contraire, redémarrez le serveur et vérifiez que le plug-in se comporte comme prévu et qu'aucune erreur ni avertissement ne s'affiche 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 mocha automatisés dans le répertoire test/.
  7. Exécutez npm run test pour exécuter les tests automatisés.
  8. Exécutez npm run lint:fix pour corriger les erreurs lint. Traitez les erreurs ou avertissements restants.
  9. Exécutez npm run format pour lancer l'outil de mise en forme automatique.
  10. Si tous les tests sont concluants, vous pouvez ouvrir une demande de pull contre master avec vos modifications.