Contribuer aux Samples

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 de ces éléments, consultez la page Structure du dépôt.

À savoir

Voici un bref aperçu des faits sur les échantillons de blocs que vous devez connaître pour créer une demande de relations publiques.

  • La branche active est master, et toutes les demandes d'extraction doivent être envoyées à la branche principale.
  • Exécutez npm install au niveau racine de blockly-samples,et non au niveau de chaque plug-in. Blockly-samples est un monodépôt, ce qui signifie qu'il contient plusieurs packages dans le même dépôt. L'installation à la racine fait partie du workflow de gestion du monodépôt 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 classiques dans vos messages de commit et vos titres de demandes d'extraction.

  • 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 au niveau racine de blockly-samples pour installer des 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 en faire une page de test utile afin que les autres utilisateurs puissent voir ce que fait votre plug-in. Pour en savoir plus, consultez la page playground.
  3. Apportez les modifications nécessaires au code du plug-in.
  4. Si vous laissez 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. É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 éventuels avertissements ou erreurs.
  9. Exécutez npm run format pour exécuter l'outil de mise en forme automatique.
  10. Si tous les tests sont concluants, vous pouvez ouvrir une demande d'extraction concernant l'instance master avec vos modifications.