Contribuer aux exemples

Blockly Samples 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 informations sur blockly-samples que vous devez connaître 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.
  • Exécutez npm install au niveau racine de blockly-samples,et non au niveau de chaque plug-in. Blockly-samples est un monorepo, 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 monorepo avec Lerna.
  • Le code doit être conforme au guide de style JavaScript ou au guide de style TypeScript de Google, selon le langage utilisé.
  • Utilisez des commits conventionnels dans vos messages de commit et les titres de vos demandes d'extraction.

  • 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 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 plug-in, vous devrez créer une page de test utile pour que les autres utilisateurs puissent voir ce que fait votre plug-in. Pour en savoir plus, consultez la page Bac à sable.
  3. Apportez les modifications nécessaires au code du plug-in.
  4. Si vous avez laissé le serveur en cours d'exécution, vos modifications seront chargées automatiquement. Sinon, redémarrez le serveur et vérifiez que le plug-in 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. Rédigez 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. Corrigez les avertissements ou les erreurs restants.
  9. Exécutez npm run format pour exécuter le formateur automatique.
  10. Si tous les tests réussissent, vous pouvez ouvrir une demande d'extraction par rapport à main avec vos modifications.