Dlight-tools

Le GitHub Dlight-tools n'est plus utilisé pour l'échange de library

Introduction

GitHub est un service web d'hébergement et de gestion de développement de logiciels, utilisant le logiciel de gestion de versions Git. Wikipedia Git est un logiciel de gestion de versions décentralisé. Wikipedia

Un logiciel de gestion de versions (ou VCS en anglais, pour Version Control System) est un logiciel qui permet de stocker un ensemble de fichiers en conservant la chronologie de toutes les modifications qui ont été effectuées dessus. Il permet notamment de retrouver les différentes versions d'un lot de fichiers connexes.

Les logiciels de gestion de versions sont utilisés notamment en ingénierie du logiciel pour conserver le code source relatif aux différentes versions d'un logiciel.

En ce qui nous concerne, l'avantage réside dans le fait que tout le monde peut contribuer à agrémenter la documentation à disposition. Par exemple : contribuer à enrichir la base de donnée de Personality pour les différentes Devices que vous avez créer pour l'utilisation des asservis dans DLight.

Présentation

Le Github de DLight (dlight-tools est composé de plusieurs dossiers (Repository ou Repo) :

• 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 un code - un logiciel. En effet le concept de base - que nous allons utiliser ici pour nos besoin - est de 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) 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 bref 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éalisé, vous allez vous retrouver sur votre compte, avec une copie du repo original. (aroomthedoomed, c'est moi - mon compte)

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. (disponible ici : mac - windows)

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ée 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 - ou dans le menu Repository > Create Pull Request soit CRT + R Finalement : cliquer sur "Send Pull Request"

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

11) Une fois votre Pull Request acceptée, vous pouvez - et même devez - vraisemblablement effacer le dossier que vous avez cloné pour l'occasion. (A confirmer par un spécialiste, mais dans le doute faites-le) En effet si un autre contributeur agrémentait la base de donné et modifiait peut-être une de vos Personality , lors de votre prochain ajout, vous risqueriez alors d'annuler ses modifications. Dans le doute, mieux vaut cloner la base de donnée à chaque fois.

Bravo et merci pour votre contribution

Plus d'infos

Pour les anglophones et quelques exemples en image Lien vers le forum ou l'aide de Github [1]