Commencer à contribuer à Blockly

Blockly est Open Source et est principalement géré par une petite équipe. Nous accueillons les contributions de développeurs externes à l'équipe de base. Sans notre communauté, nous ne pourrions pas développer toutes les fonctionnalités demandées ni corriger tous les bugs signalés. Cette section contient des guides généraux qui peuvent vous être utiles, en particulier si vous débutez dans le développement Open Source.

Pour en savoir plus sur Blockly avant de contribuer, consultez les sections Contribuer au noyau et Contribuer aux exemples.

Quel dépôt ?

Un dépôt contient tous les fichiers d'un seul projet. Blockly dispose de deux dépôts: blockly core et blockly-samples.

Blockly Core est le dépôt de la bibliothèque Blockly. Utilisez ce dépôt si vous souhaitez modifier le comportement de base de Blockly de manière à ce qu'il s'applique à tous les utilisateurs de la bibliothèque.

Exemples Blockly est le dépôt des exemples, des plug-ins et des ateliers de programmation. Utilisez ce dépôt si vous souhaitez créer ou modifier un plug-in, écrire un atelier de programmation ou créer ou modifier un exemple.

Procédure détaillée

Voici les étapes générales que vous devez suivre chaque fois que vous apportez une modification.

  1. Installez Git et Node en suivant les liens de la section Outils.
  2. Dupliquez et clonez le dépôt. GitHub propose un excellent tutoriel sur la création d'un fork. Pour l'appliquer à Blockly, remplacez simplement chaque instance de octocat/Spoon-Knife par google/blockly ou google/blockly-samples, en fonction du dépôt dans lequel vous souhaitez travailler.
  3. Synchronisez votre fork. GitHub propose également un tutoriel sur la synchronisation d'un fork.
  4. Consultez la branche principale. Dans le noyau Blockly, il s'agit de la branche develop. Dans blockly-samples, il s'agit de la branche master.
  5. Installez les dépendances et les outils de compilation en exécutant npm install dans le répertoire racine.
  6. Créez une branche en exécutant git checkout -b myBranchName dans un terminal. Ce nom doit vous aider à vous souvenir de ce sur quoi vous travaillez.
  7. Apportez les modifications souhaitées.
  8. Validez vos modifications en suivant le guide pour le noyau ou les échantillons.
  9. Enregistrez les modifications avec git commit -am "fix: My commit message". En savoir plus sur les messages de commit
  10. Transférez vos modifications vers GitHub avec git push origin myBranchName.
  11. Ouvrez une demande d'extraction lorsque votre code est prêt. Un membre de l'équipe Blockly examinera vos modifications et les fusionnera dans Blockly si elles sont approuvées. Pour en savoir plus, consultez le processus d'examen des communiqués de presse.