Dlight-tools

Introduction

Qu'est-ce que le Git Hub ? ask google

L'avantage c'est que tout le monde peut contribuer à agrémenter la documentation à disposition. Par exemple et surtout : contribuer à enrichir la base de donnée de Personality pour les différentes Devices que vous avez créer.

Présentation

Le Git Hub de DLight (dlight-tools est composé de plusieurs dossier (repository) :

• dlight-pad : outils pour controller DLight depuis différent devices (smartphone, tablette, ...)
• dlight-midi : goodies pour contrôleur midi
• dlight-devices : bibliothèque de Devices's Personality pour DLight
• dlight-seqcon : utilitaire pour synchroniser DLight et un séquenceur audio
• dlight-book : projet de mode d'emploi pour les anglophones

Le concept de contribution

Github est prévu à la base pour travailler à plusieurs sur du code. En effet le concept de base - que nous allons utiliser ici pour nos besoin - est ce copier un code (Fork), soit créer une nouvelle branche de celui-ci, afin d'y travailler, pour ensuite, après modification, demander au proprio (Master - branche principale - tronc) s'il veut bien incorporer (Merge) les modifications au code original. Et tout ceci au moyen d'un "Pull request", qui consiste à envoyer notre nouvelle version (Commit) accompagnée par un texte d'explication concernant notre modification.

Vous n'avez pas tout compris ? Moi non plus, pas encore. L'essentiel c'est que vous puissiez contribuer - vous ne pouvez de toute manière casser grand chose, assurément.

Marche à suivre

Pour ajouter un document à un des repos (par exemple ici : dlight-devices)

1) Join GitHub ! ou se loguer sur votre compte

2) Une fois logué, allez sur la page du dlight-tools auquel vous voulez contribuer (par exemple ici : dlight-devices).

Vous êtes bien sur le repo de dlight tout en étant logué avec votre compte.

3) Forker le repo en cliquant sur le bouton Fork en haut à droite.

Une fois le fork réaliser, vous allez vous retrouver sur votre compte, avec une copie du repo original.

4) Cloner le fork du repo sur votre ordinateur, à l'aide du bouton dans le menu sur la droite "Clone in Desktop"

C'est à ce moment là - je suppose - que Github va vous proposer d'installer un utilitaire - software pour gérer le dossier sur votre ordinateur. Téléchargez et installez-le.

5) Une fois le logiciel Github installé et après avoir cliqué sur "Clone in Desktop", choisissez un endroit sur votre ordi où cloner les documents.

Il devrait déjà avoir un dossier créer par le logiciel. mais vous pouvez choisir n'importe quel dossier et en créer un juste pour l'occasion.

6) Une fois le dossier cloné, vous pouvez enfin ajouter votre contribution.

Pour cet exemple (dlight-devices), les Personality sont classées par Fabricant et Modèles (nom du fichier). Faites de même avec votre ajout et créer un dossier pour un nouveau fabricant au cas où.

7) Une fois votre fichier ajouté au dossier cloné, vous allez pouvoir constater les modifications dans l'onglet "Changes" du logiciel.

8) Sélectionner le fichier que vous avez ajouté, entrer un bref commentaire (summary), cliqué sur l'icône ave le + et les deux flèches circulaires pour passer de "Commit" à "Commit and sync", cliquer sur "Commit and sync"

Voilà, c'est presque terminé. Il vous faut maintenant encore demander au proprio de bien vouloir incorporer votre "Fork" à la branche principale. Car pour l'instant vous n'avez modifié que votre copie, sur votre compte Git.

9) Vous devez créer un "Pull Request". Cliquez sur l'icône qui ressemble à un relais électronique (une image serait la bienvenue non?) - ou dans le menu Repository > Create Pull Request soit CRT + R (plus simple non ?) Finalement : cliquer sur "Send Pull Request"

10) Votre Pull Request doit être validé par le proprio. Vous serez alors avertit par une notification.

Bravo et merci pour votre contribution