Apprendre à utiliser Github

le 16 aout 2014 • Programmation • par mandalorien

Vous êtes développeur et travaillez en équipe ? Vous êtes plusieurs et vous avez parfois du mal à vous organiser dans le développement de votre projet ? Changez votre façon de développer dès aujourd'hui avec Github !

Comprendre la notion de subversionning est une chose mais l'appliquer et/ou l'utiliser avec Github en est une autre !

Nous avons déjà abordé les principes du fonctionnement de Github dans cet article: Le subversionning avec Github.

Cet outil puissant peut être employé de plusieurs manière :

Directement depuis le site officiel de Github (oui c'est possible!) .
Via une application à installer sur votre OS (Système d'explotation).

En ce qui concerne la seconde façon d'utiliser Github, il existe deux applications bien distinctes l'une de l'autre:

Github Shell

Github App

Personnellement, je privilégie la première méthode qui consiste en l'utilisation de la plateforme en ligne de Github. En ce qui concerne les deux applications présentées, Github App est beaucoup plus conviviale et facile de prise en main que Github Shell qui s'exécute en ligne de commande.

Cet article ne parlera que de l'utilisation de Github depuis la plateforme officielle en ligne. L'utilisation de Github à l'aide des deux applications présentées plus haut fera l'objet d'un second article.

Utilisation de Github via le site web

Vous accédez à la page d'accueil de Github. Notez que le site est en anglais. Renseignez directement votre nom d'utilisateur, adresse mail et mot de passe sur la page d'accueil.

Pour l'occasion, j'ai crée un compte "Kommunauty" bidon.

Une fois vos informations tapées et validées, vous arrivez sur une page intéressante puisqu'elle vous permet de choisir le type de plan auquel vous souhaitez souscrire:

Chaque plan vous permet de disposer d'un nombre limité d'espaces privés. Le plan gratuit ne vous permettant pas de protéger vos fichiers du public. Comme il a été expliqué dans l'article sur le subversionning, l'utilisation gratuite de Github expose vos fichiers à des téléchargements par d'autres utilisateurs. Pour protéger donc vos fichiers du téléchargement par des utilisateurs non autorisés, il vous faudra payer.

Une fois votre sélection effectuée, il ne vous reste plus qu'à valider votre choix.

Vous êtes alors directement connecté sur le site. La première chose à faire consiste à créer un repository.

Qu'est ce qu'un repository ?

Pour faire simple comme déjà expliqué plus haut, c'est un dossier (public ou privé) dans lequel seront stockés les fichiers de votre projet

Repository name : Nom du dossier.

Description (optional) : la description (elle est facultative).

Si vous avez payé, vous avez le choix de définir l'accès au dossier comme privé ou public.

Veillez à bien cocher la case : Initialize this repository with a README . Il nous permettra d'accéder à un petit texte d'introduction avec des informations complémentaires sur votre repository.

.gitignore : c'est un fichier important puisqu'il empêche le commit des extensions ou fichiers précisés dedans. Pour ma part j'ai l'habitude de mettre le fichier config.php et d'enlever l'extension .mo (fichier langue de xnova par exemple) dedans étant donné que si je travaille avec un développeur, je n'aimerai pas qu'il me fasse à chaque amélioration, un changement de la connexion BDD.

Licence : ça c'est à vous de voir par rapport à votre projet

La mise en place d'un projet via le site si vous partez de zéro ne pose généralement pas de problèmes. Par contre si vous avez déjà 200 fichiers développés sans être passé préalablement par l'application Github, ça sera un peu plus compliqué.

Une fois votre repository crée une nouvelle page va apparaître avec des informations: Vos repositories ou forks à gauche et vos contributions à droite.

Forks : Ce sont des copies des repositories d'autres utilisateurs dans votre compte. Il est simple de voir la différence entre un Fork et un repository

Bref, si vous êtes là c'est parce que vous recherchez une méthode efficace de travail en groupe. Voila comment ajouter un utilisateur à votre projet ou bien suivre un projet/utilisateur.

Dans le champs de recherche en haut du site, saisissez: kommunauty . Puis sur la nouvelle page qui va s'afficher, sélectionnez sur la gauche : Users

Attention: Il ne faut pas confondre suivre un utilisateur et suivre un projet !

Si vous Follow un utilisateur, vous aurez des infos de toutes ses modifications sur ses repositories et ses contributions sur d'autres repositories (il faut être un Fan quoi ).

En revanche, si vous ajoutez au favoris et regardez le repository d'un utilisateur , vous n'aurez que des notifications lors de modifications, améliorations ou de suppression des fichiers du repository en question.

Par exemple en ce qui concerne la contribution collective, je vais autoriser mon compte mandalorien à participer au repository "Exemple" du compte Kommunauty.

Je me connecte avec le compte Kommunauty puis je rentre dans le repository: Exemple.

Vous apercevrez en bas à droite un lien avec une icône settings.

Cliquez dessus puis sur la nouvelle page, cliquez sur: Collaborators. Saisissez ensuite le nom du développeur à ajouter et le tour est joué. Dans ce cas, l'utilisateur mandalorien (que j'ai ajouté) pourra apporter toutes les modifications qu'il veut sans attendre une modération du compte Kommunauty.

issue : C'est une notification pour informer les développeurs d'un bug , d'une duplication du projet ou pour poser des questions...

Il est important de l'utiliser pour permettre à l'équipe de développeurs de corriger les bugs et donc d'intervenir plus rapidement.

Commits: Ce sont les modifications ou améliorations apportées par l'équipe. Chaque commit est accompagné d'un titre et d'une description. Le fait d'être organisé dans son travail et de bien expliquer le commit effectué rend le travail pour les invités et l'équipe plus facile à prendre en main.

branch : L'utilisation de branch est importante lorsque vous voulez développer plusieurs versions. Exemple: Une version communauté accessible à tous et une version payante

Voilà, c'est la fin de cet article. Il y aura un troisième tutoriel sur l'utilisation de Github via les applications mises à disposition en téléchargement.

J’espère avoir été très explicite dans les explications mais si vous avez des questions n'hésitez pas à poster un commentaire, créer un sujet sur le forum de kommunauty ou me contacter