• Welcome to Forum des utilisateurs de Blockly(s). Please login or sign up.
 

Petit guide pour contribuer à Blockly@arduino avec git

Démarré par ucino, janvier 13, 2019, 11:57:10 pm

« précédent - suivant »

ucino

janvier 13, 2019, 11:57:10 pm Dernière édition: janvier 21, 2019, 12:37:48 am par ucino
Hello,

Débutant avec github, sa méconnaissance peut-être un frein chronophage pour contribuer à Blockly@arduino.

L'objectif de ce fil de discussion est d'essayer de proposer un petit guide pratique pour gagner du temps à ceux qui sont ou seront dans le même cas.

Attention, il comporte peut-être des erreurs, a été initié par un débutant et est en cours d'expérimentation et pas encore testé.

Présentation des objectifs du tutoriel

Vous aimeriez contribuer à Blockly@arduino ? Ajouter de nouveaux de nouveaux blocs, enrichir les traductions, les images ou proposer des corrections ?

Git est très pratique pour cela, il vous fera gagner beaucoup de temps, ainsi qu'aux autres contributeurs.

Mais vous ne savez pas utiliser Git et Github ?

Pas de soucis, ce tuto est là pour cela, tout sera expliqué pas à pas, pour les utilisateurs sous GNU/Linux.

Installer git

Sous debian et ubuntu :

    sudo apt update
    sudo apt install git


Se créer un compte sur github

1) Aller sur https://github.com/ et créez-vous compte (si vous avez des problèmes à la création du compte, débloquez peut-être juste le temps de créer un compte des addons de sécurité qui peuvent empêcher un test anti-spam de se mettre en œuvre) ;
2) consultez vos emails (dont le dossier spam) et cliquez sur le lien pour valider votre compte (sinon vous ne pourrez pas forker comme expliqué ci-après) ;
3) puis identifiez-vous si vous ne l'êtes pas (mais normalement vous devez l'être suite à la création du compte).

[Note] si quelqu'un sait s'il est possible d'utiliser https://framagit.org/ à la place de github en tant que contributeur sans que cela complique la vie de Seb, merci de le dire, le tuto sera alors réalisé en utilisant https://framagit.org/ pour éviter les dérives de centralisation des pouvoirs comme cela avait été le cas avec google code qui appliquait l'embargo US et empêchait ainsi aux résidents de certains pays (ex. Syrie) de télécharger et contribuer à des logiciels libres.[finNote]

Ne pas prendre de risques

Il pourrait y avoir 2 types de contributions à Blockly@arduino avec git. Soit Seb vous a donné les droits pour téléverser vos améliorations directement sur son dépôt, soit non.

Ici on est dans un cadre débutant pour javascript, blockly@rduino et github, on ne prend pas de risques de tout casser chez Seb, et on envisage donc que vous n'avez pas les droits de verser directement votre code sur le repository de Seb. Ce tuto suit donc cette logique.

Forker le dépot de Blockly@arduino sur votre compte github

1) Via votre navigateur et logué donc sur github, allez sur https://github.com/technologiescollege/Blockly-at-rduino/ et en dessous de la barre jaune cliquez sur le bouton "Create new file".

En faisant cela, vous avez créé une copie (un fork) du dépôt de Blockly-at-rduino sur votre espace github, sur lequel vous pourrez ajouter tranquillement vos améliorations.

2) Une nouvelle page avec un espace vide a été créé, on n'y prête pas attention, allez tout en haut à droite et cliquez sur l'icône rectangulaire > Your repositories. Nous arrivons maintenant sur votre page de dépôts, et nous retrouvons le fork (copie) de blockly@rduino. Cliquons dessus pour que s'affiche https://github.com/VOTREIDENTIFIANTGIT/Blockly-at-rduino

Télécharger votre dépôt sur votre ordinateur

Pour pouvoir tester et éditer facilement le code de votre dépôt Blockly@arduino, nous allons le télécharger sur votre ordinateur.

Pour cela :

* Créer un dossier dans votre ordinateur qui va contenir votre dépôt (ex. MonDepotBlocklyAtArduino)
* Entrer dans ce dossier
* Y ouvrir un terminal (ex. clic droit > Ouvrir un terminal ici)
* Entrer dans le terminal la commande suivante :
git clone https://github.com/XXXXXXX/Blockly-at-rduino.git
Où XXXXXXX est à remplacer par votre identifiant github

* Patienter jusqu'à le dépôt sont entièrement téléchargé.

Préparer votre dossier

* Entrer cd Blockly-at-rduino/ pour entrer dans le dossier que vous venez télécharger.

* Configurer l'accès : git config --global user.name "MonPrénom MonNom"
* Vérifier que le dépôt est bien à jour : git pull

Félicitations, vous pouvez maintenant apporter vos modifications et ajouts !

Réaliser les modifications ou ajouts de nouveaux fichiers
* À vous de jouer ! (cf. http://www.libreduc.cc/wiki/doku.php/fr/arduino/blockly_rduino/creerblocsmultiling )

* Vérifions maintenant le bon fonctionnement en cliquant sur index.html contenu dans le dossier Blockly-at-rduino

Ajouter les modifications réalisées sur votre ordinateur dans votre fork dépôt github

Dans cet exemple, nous partons du principe que vous n'avez pas ajouté de nouveaux fichiers, seulement modifiés des fichiers existants.

* Regardons ce qui a été modifié sur votre ordinateur ("en local") : entrez dans le terminal git status

Une ou plusieurs lignes rouges dans votre terminal devraient reprendre les fichiers que vous avez modifiés.

* Entrons dans le terminal git commit -a pour que ces modifications soient sujettes à être uploadées dans votre dépoôt forké.

* Dans votre terminal, un nouvel espace s'affiche. Indiquez de manière synthétique pourquoi vous avez réalisé ces modifications (ex. Correction moteurs pas à pas unipolaires pour que quand 2 blocs de config moteurs pas à pas sont déposés, il y ait bien 2 vitesses initiales prises en compte au lieu d'une seule.)

* Faire Ctrl + O pour valider votre commentaire, Entrée, puis Ctrl + X pour revenir en arrière.

* Entrer dans le terminal git push pour que soient envoyés vos modifications dans votre dépôt git en ligne.

* Votre identifiant github vous est demandé, entrons-le, puis appuyer sur Entrée.

* Puis votre mot de passe de votre compte github, puis appuyer sur Entrée.

Bravo vous venez d'uploader vos modifications. Vous pouvez aller sur https://github.com/VotreIdentifiant/Blockly-at-rduino pour vérifier le résultat, vous verrez notamment votre commentaire qui s'affiche.

Informer Seb que vous avez réalisé une modification pour qu'il puisse l'intégrer

Maintenant que vous avez contribué au code de Blockly@rduino, nous allons en faire part à Seb avec github.

* Aller sur https://github.com/VotreIdentifiant/Blockly-at-rduino

* Cliquer sur le bouton gris en dessous de la barre jaune "New pull request"

* Cliquer sur le bouton vert "Create pull request" une première fois, puis une deuxième fois.

Voilà, Seb devrait en être automatiquement notifié, à voir maintenant s'il l'ajoutera sur son dépôt !

Tuto en cours de rédaction la suite à venir dans les jours qui viennent...

SebCanet

Merci mille fois !!!!
Dès que c'est au point, je le rajoute au wiki !

ucino

Merci pour ton retour.

J'essaie de résoudre les 2 problèmes que tu avais soulignés sur le moteur pas à pas, et je reprends le tuto en ayant ainsi un cas d'usage à mettre en œuvre (remonter les corrections du moteur pas à pas via github).

SebCanet