Accéder au contenu principal

18F : Prestation de services numĂ©riques | Comment utiliser GitHub et le terminal : un guide

18F : Prestation de services numĂ©riques | Comment utiliser GitHub et le terminal : un guide



Comment utiliser GitHub et le terminal : un guide

Nous avons dĂ©jĂ  Ă©crit que tout ce que nous faisons est ouvert dĂšs le premier jour . L'une des façons dont nous y parvenons consiste Ă  crĂ©er tous nos produits, de notre blog et de notre tableau de bord Ă  un nouveau site Web pour l'initiative Let Girls Learn du Peace Corps, Ă  l'aide de GitHub. Nous faisons cela pour que le public puisse voir le code sur lequel nous travaillons, offrir des commentaires et copier ou forker ce code pour leurs propres projets. Si vous n'avez jamais utilisĂ© GitHub auparavant, cela peut ĂȘtre un peu intimidant, nous aimerions donc partager le didacticiel que nos propres nouveaux employĂ©s utilisent lorsqu'ils commencent avec 18F.

Nous embauchons des personnes d'horizons diffĂ©rents et chaque nouvel employĂ© apporte un niveau de confort diffĂ©rent avec les outils spĂ©cifiques que nous utilisons sur nos diffĂ©rents projets. L'Ă©quipe qui gĂšre le site Web 18F a rĂ©cemment commencĂ© Ă  Ă©crire les outils et les processus que nous utilisons pour mettre Ă  jour le blog et le code qui exĂ©cute le site.

Étant donnĂ© que certaines des personnes que nous embauchons n'ont jamais utilisĂ© ces outils auparavant, ce guide suppose que vous n'en avez aucune connaissance prĂ©alable non plus. Nous allons vous prĂ©senter GitHub , la ligne de commande (aussi appelĂ©e Terminal sur OS X), et Markdown Ă  travers un exercice guidĂ©. Aujourd'hui, vous allez apprendre Ă  crĂ©er un article de blog sur le blog 18F .

Chaque Ă©tape sera illustrĂ©e par une capture d'Ă©cran utile ou un GIF animĂ© qui vous montre exactement Ă  quoi votre Ă©cran devrait ressembler. Nous allons passer par chaque Ă©tape dans l'ordre. Ă€ la fin de cet article, vous saurez comment :

  1. Transformez votre Mac en une machine de développement Web
  2. Premiers pas avec GitHub et le terminal
  3. Cloner un dépÎt sur votre ordinateur
  4. Construire le site 18F
  5. Créer une branche
  6. Modifier et valider un article de blog
  7. Ajouter une matiĂšre liminaire
  8. Apprenez Ă  faire une demande d'extraction

Il convient de noter qu'il existe de nombreuses façons diffĂ©rentes d'effectuer chacune de ces Ă©tapes. Par exemple, il existe des applications pour utiliser Git comme GitHub pour Mac et Windows, ou Tower ; des dizaines d'Ă©diteurs de texte diffĂ©rents ; et des concurrents de GitHub comme Bitbucket ou SourceForge . Vous pourriez les explorer par vous-mĂȘme. Cet article est un tutoriel destinĂ© Ă  prĂ©parer les gens Ă  travailler avec l'Ă©quipe du site Web de 18F.

Si vous avez une autre façon d'effectuer l'une de ces Ă©tapes, ou si vous avez des moyens de rendre cela plus efficace, veuillez nous en informer en publiant un problĂšme ici . (Vous n'avez pas besoin de savoir coder pour publier un problĂšme, mais vous avez besoin d'un compte GitHub.)

Ce dont vous avez besoin pour commencer : un compte GitHub et Mac OS X. Ces instructions sont principalement destinĂ©es aux Mac, mais la plupart des instructions fonctionneront de la mĂȘme maniĂšre sur un ordinateur Linux. Si vous travaillez sous Windows, nous vous suggĂ©rons de consulter ce commentaire publiĂ© sur GitHub qui dĂ©taille comment faire fonctionner ces instructions pour les machines Windows.

Transformez votre Mac en une machine de développement Web

Vous utilisez Linux ? Vous pouvez ignorer cette section.

Notre collĂšgue Moncef Belyamani a Ă©crit un script qui transforme votre Mac en une machine de dĂ©veloppement web en 15 minutes environ. Il vous sera demandĂ© d'entrer le mot de passe de votre ordinateur Ă  trois reprises au cours de l'installation. Le terminal ne fournit aucun retour lorsque vous saisissez votre mot de passe. Tapez-le simplement et appuyez surenter.

Si vous prĂ©fĂ©rez ne pas utiliser le script, vous pouvez Ă©galement suivre les instructions dĂ©taillĂ©es qu'il a Ă©crites sur son site Web . Ou suivez cette vidĂ©o qu'il a prĂ©parĂ©e avec des instructions Ă©tape par Ă©tape pour transformer votre Mac en une machine de dĂ©veloppement Web. Pour utiliser le script, suivez les instructions dans le texte ci-dessous :

  • Activez le terminal en appuyant sur commande + espace, puis en tapant "Terminal" dans le champ de recherche.

L'icĂŽne du terminal ressemble Ă  ceci :

Application terminale

Et vous devriez avoir une fenĂȘtre comme celle-ci lorsque vous l'ouvrez :

Capture d'Ă©cran d'une fenĂȘtre de terminal vide

  • Allez dans Terminal et collez ce qui suit curl --remote-name https://raw.githubusercontent.com/18F/laptop/master/macet appuyez sur EntrĂ©e.

  • Ensuite, collez bash mac 2>&1 | tee ~/laptop.log && source ~/.rvm/scripts/rvmet appuyez sur EntrĂ©e. Cela met en place tous les logiciels dont vous avez besoin pour gĂ©rer les langues que nous utilisons Ă  18F. (Pour une liste complĂšte des programmes, cliquez ici ).

Premiers pas avec GitHub et le terminal

Terminal est un programme qui vous permet d'envoyer des commandes Ă  votre ordinateur, et le texte que vous avez collĂ© ci-dessus est un exemple du fonctionnement de ces commandes. Dans ce guide, chaque fois que vous voyez un texte qui ressemble Ă  this, vous lisez une commande. Tapez les commandes exactement comme vous les voyez ici (ou copiez-les et collez-les dans votre terminal) et appuyez toujours sur retour Ă  la fin.

Vous allez beaucoup voir le mot "rĂ©pertoire" dans ce tutoriel. RĂ©pertoire est un autre mot pour dossier. Les rĂ©pertoires sont des emplacements spĂ©cifiques pour les fichiers sur votre ordinateur, et le terminal prend toujours les commandes Ă  partir d'un rĂ©pertoire. Si nous disons que nous "travaillons dans un rĂ©pertoire", cela signifie que le terminal part de cet emplacement. Jouons un peu avec les rĂ©pertoires :

  1. Tapez ls: cela vous montrera tout dans le rĂ©pertoire oĂč vous vous trouvez actuellement. Si vous tapez, ls -1il les listera tous dans une seule colonne pour vous. lssignifie " l i s t " et -1indique Ă  votre ordinateur de rĂ©pertorier le rĂ©pertoire dans une colonne. Si vous ĂȘtes dans votre rĂ©pertoire personnel, vous verrez probablement une liste dans Terminal similaire Ă  cette capture d'Ă©cran :

Capture d'Ă©cran : rĂ©pertoire personnel

  1. Tapez maintenant cd Documents: cela vous amĂšnera dans votre rĂ©pertoire Documents, si c'Ă©tait l'une des options affichĂ©es lorsque vous avez utilisĂ© la commande 'ls' ci-dessus. cdsignifie « changer d' annuaire ».
  2. Tapez ls -1Ă  nouveau pour voir tous les fichiers dans votre rĂ©pertoire Documents.
  3. Typels -1F : remarquez une diffĂ©rence ? Tout Ă©lĂ©ment de la liste avec un /Ă  la fin est un autre rĂ©pertoire.
  4. Tapez cd ..pour revenir en arriĂšre d'un rĂ©pertoire. Les rĂ©pertoires s'empilent les uns sur les autres et le rĂ©pertoire "au-dessus" de votre rĂ©pertoire actuel est toujours appelĂ©..
  5. Tapez pwd: cette commande vous indique le rĂ©pertoire dans lequel vous travaillez actuellement. pwdsignifie « rĂ©pertoire de travail d' impression ». Vous devriez voir quelque chose qui commence par /Users/, suivi du nom d'utilisateur de votre ordinateur. C'est ce qu'on appelle votre rĂ©pertoire personnel et vous pouvez toujours y accĂ©der en tapant cd ~.

J'aime mettre tous mes projets GitHub dans le mĂȘme rĂ©pertoire. Donc, la premiĂšre chose que je fais est de crĂ©er un rĂ©pertoire appelĂ© "code":

  1. cd ~pour vous assurer que vous ĂȘtes dans votre rĂ©pertoire personnel
  2. mkdir code: pour crĂ©er le rĂ©pertoire appelĂ© codedans votre rĂ©pertoire personnel. mkdirsignifie M a k e directory .
  3. cd codedevrait amener votre terminal dans votre répertoire de code.

Conseil de pro : vous pouvez toujours revenir Ă  votre rĂ©pertoire de code en tapantcd ~/code

Capture d'Ă©cran : saisie du code mkdir

Cloner un dépÎt sur votre ordinateur

  • Tout d'abord, vous souhaitez vous connecter Ă  GitHub. Allez sur https://github.com/login et connectez-vous avec votre nom d'utilisateur et votre mot de passe.

Nous pouvons maintenant commencer Ă  travailler avec le site Web. GitHub est un systĂšme qui stocke les fichiers et enregistre les modifications qui leur sont apportĂ©es Ă  l'aide d'un logiciel appelĂ© Git , qui permet Ă  plusieurs personnes d'apporter des modifications distinctes Ă  un programme en mĂȘme temps sans se gĂȘner les unes les autres. Si notre programme Ă©tait un essai de cinq paragraphes, Git permet Ă  Corey d'Ă©diter l'introduction sur un ordinateur tandis que Jesse Ă©dite la conclusion ailleurs. Lorsque les deux sont terminĂ©s, ils peuvent dĂ©placer leurs modifications en une seule copie tout en prĂ©servant les modifications de chaque personne.

Si vous avez dĂ©jĂ  utilisĂ© "Suivre les modifications" dans le traitement de texte (oĂč les modifications sont mises en surbrillance pour ĂȘtre approuvĂ©es ou rejetĂ©es), Git est comme ça, mais avec beaucoup plus de fonctionnalitĂ©s. Dans le dĂ©veloppement logiciel, Git et d'autres outils de contrĂŽle de version sont utiles pour rechercher l'origine d'un bogue. Disons qu'un code ne fonctionne pas, mais que 15 personnes y ont apportĂ© des modifications la semaine derniĂšre et que vous ne savez pas oĂč se trouve le bogue. Avec Git, vous pouvez charger une ancienne version d'un programme, tester le problĂšme, puis "avancer" dans les modifications des utilisateurs jusqu'Ă  ce que vous trouviez le premier qui pose Ă©galement le problĂšme. Cela vous indique la modification spĂ©cifique pour rechercher l'erreur.

GitHub est un site Web qui affiche des informations de Git. Par exemple, ce lien montre une modification orthographique de ce message par Melody. Cela permet Ă©galement une discussion facile sur les modifications proposĂ©es ou, pour les personnes qui n'ont pas accĂšs Ă  l'Ă©dition, aux problĂšmes de rĂ©daction qu'ils considĂšrent comme des « problĂšmes ». Voici un fil de discussion que nous avons crĂ©Ă© spĂ©cifiquement pour les commentaires sur ce post !

Dans cette section, vous verrez les mots « clone », « dĂ©pĂŽt » et sa forme abrĂ©gĂ©e, « dĂ©pĂŽt ». Chaque projet sur GitHub est appelĂ© un "dĂ©pĂŽt" ou un "dĂ©pĂŽt" ; vous pouvez voir la liste des dĂ©pĂŽts de 18F sur ce lien . Un dĂ©pĂŽt contient l'historique complet du projet avec des pointeurs appelĂ©s "commits" reprĂ©sentĂ©s par des "SHA" qui indiquent quand et oĂč chaque fichier a Ă©tĂ© modifiĂ©, et comment il a changĂ© exactement. Lorsque vous "clonez" un rĂ©fĂ©rentiel, vous tĂ©lĂ©chargez l'intĂ©gralitĂ© du projet ainsi que son historique sur votre ordinateur. Une fois que vous avez clonĂ© un projet, vous pouvez apporter des modifications sur votre ordinateur sans affecter le projet tel qu'il existe sur GitHub.

Dans cette Ă©tape, nous allons cloner le projet 18f.gsa.gov sur votre ordinateur.

  • Tapez cd ~/codeet appuyez sur EntrĂ©e pour accĂ©der au coderĂ©pertoire que nous avons crĂ©Ă© prĂ©cĂ©demment.

Capture d'Ă©cran : saisie du code du cd

  • AccĂ©dez Ă  la page GitHub de 18f.gsa.gov et regardez sur le cĂŽtĂ© droit de la page, sous les liens pour "Issues" et "Graphs". Vous verrez qu'il est Ă©crit "Vous pouvez cloner avec HTTPS, SSH ou Subversion". Cliquez sur le lien SSH et copiez l'URL (adresse Web) qui se trouve dans cette zone de texte dans votre presse-papiers.

Si vous ne faites pas partie de l'Ă©quipe 18F mais que vous suivez ces instructions, vous devrez « bifurquer » ce rĂ©fĂ©rentiel afin de suivre le reste des Ă©tapes ci-dessous. Vous pouvez bifurquer ce rĂ©fĂ©rentiel en visitant : https://github.com/18F/18f.gsa.gov/fork/ . Ensuite, utilisez le lien SSH pour votre fork au lieu de celui ci-dessus. La documentation de GitHub contient plus d'informations sur les forks et leur utilisation .

  • Tapez git clone puis collez l'URL que vous avez copiĂ©e dans votre presse-papiers. Cela copie maintenant le rĂ©fĂ©rentiel 18f.gsa.gov sur votre ordinateur local.

capture d'Ă©cran : clonage du dĂ©pĂŽt

Si vous rencontrez une erreur ici et que vous avez exĂ©cutĂ© le script Laptop, vous devez ouvrir et enregistrer votre application de bureau GitHub. Le script installe l'application, mais l'application ne gĂ©nĂ©rera pas automatiquement de clĂ© SSH tant que vous ne vous connecterez pas avec les informations d'identification de votre compte GitHub 18F. Ouvrez simplement le bureau GitHub et il vous guidera en tant que premier utilisateur. Vous validerez votre ordinateur local avec 2FA, puis cocherez quelques cases supplĂ©mentaires. AprĂšs avoir terminĂ©, rĂ©essayez la git clone [url]commande.

Si vous rencontrez une erreur ici et que vous n'avez pas utilisĂ© le script Laptop mentionnĂ© ci-dessus, vous devez crĂ©er ce qu'on appelle une clĂ© SSH. Vous pouvez suivre les instructions qui se trouvent ici . (Conseil de pro : vous tapez tout sauf le $.) Vous ne devez le faire qu'une seule fois. Une clĂ© SSH est un petit fichier qui se trouve sur votre ordinateur et indique Ă  GitHub qui vous ĂȘtes. C'est un peu comme un mot de passe que votre ordinateur tape automatiquement pour vous. Chaque fois que vous utilisez cet ordinateur pour cloner un projet ou tirer/pousser un projet, cette clĂ© SSH sera utilisĂ©e. Vous devrez le faire sur chaque ordinateur que vous avez. Donc, si vous prĂ©voyez de travailler sur ces projets sur un ordinateur sĂ©parĂ©, vous devrez recommencer ce processus.

Branchement et demandes d'extraction

Revenons au rĂ©fĂ©rentiel 18f.gsa.gov depuis votre navigateur Web.

Sur cette page, vous verrez une liste des fichiers et dossiers de ce projet. Tous les articles du blog se trouvent dans un dossier appelĂ© _posts.Toutes les pages se trouvent dans un rĂ©pertoire appelĂ© _pages.Il y a un fichier readme qui explique Ă  quiconque parcourt 18f.gsa.govle rĂ©fĂ©rentiel GitHub de 18F comment cela fonctionne. En haut de cette fenĂȘtre, vous pouvez voir une liste dĂ©roulante indiquant "branche : staging ".

Vous voyez sur le site Web une autre vue des fichiers et des dossiers, comme indiquĂ© ici :

Capture d'Ă©cran : dĂ©pĂŽt de 18f.gsa.gov dans le dossier mac

Si vous cliquez sur le branch:stagingbouton, vous pouvez voir une liste de toutes les "branches" qui existent sur ce projet. Chaque fois que vous venez directement sur 18f.gsa.gov , il vous montrera la branche intermĂ©diaire car nous avons fait de cette branche la branche par dĂ©faut.

Les branches sont de petits bacs Ă  sable permettant aux autres personnes travaillant sur le projet de prĂ©parer des contributions sans interfĂ©rer avec le projet principal. Lorsque vous avez terminĂ© la prĂ©paration, vous Ă©mettez ce qu'on appelle une « pull request » de votre succursale Ă  une autre. Habituellement, nous envoyons des demandes d'extraction Ă  la branche par dĂ©faut. Cela ouvre une conversation sur votre contribution et si l'Ă©quipe dĂ©cide que tout va bien, nous « fusionnerons » la pull request et inclurons votre travail. La branche par dĂ©faut sur 18f.gsa.gov est "staging". Dans d'autres projets, vous pouvez le voir appelĂ© "maĂźtre".

Dans l'étape suivante, nous allons créer une branche, et plus tard, lorsque vous ferez une demande d'extraction, GitHub supposera automatiquement que vous essayez de contribuer à la branche intermédiaire.

Capture d'Ă©cran : montrant Ă  quoi ressemble le site GitHub 18f

Sur le cĂŽtĂ© droit, vous pouvez Ă©galement voir une liste des demandes d'extraction et des problĂšmes existants. Toutes les pull requests vont Ă  la branche de staging. Lorsque nous fusionnons la demande d'extraction avec la branche intermĂ©diaire, GitHub apporte automatiquement ces modifications dans le projet, mais ne les met pas encore en ligne sur https://18f.gsa.gov.

Dans Terminal, saisissez les commandes suivantes :

  • cd 18f.gsa.govpour changer de rĂ©pertoire en 18f.gsa.gov.
  • ls -1Fpour voir tous les fichiers et dossiers du rĂ©fĂ©rentiel GitHub, tels que vous les avez vus sur GitHub
  • git status

Cette derniĂšre commande vous montrera un peu d'informations sur ce sur quoi vous travaillez en ce moment. DĂ©couvrons ceci ligne par ligne :

  • "On branch staging" vous indique sur quelle branche vous travaillez actuellement (rappelez-vous que c'est stagingpar dĂ©faut). Si vous apportez des modifications et que vous les validez, vous les validerez dans la stagingbranche.
  • "Votre branche est Ă  jour avec" l'origine / la mise en scĂšne "" signifie que votre branche est Ă  jour avec la branche de mise en scĂšne de l'emplacement distant appelĂ© "origine". Un rĂ©fĂ©rentiel Git peut avoir n'importe quel nombre d'emplacements distants avec lesquels il peut interagir, appelĂ©s "distants". Par dĂ©faut, lorsque vous clonez un rĂ©fĂ©rentiel GitHub, une tĂ©lĂ©commande appelĂ©e "origine" est crĂ©Ă©e et pointe vers le rĂ©fĂ©rentiel sur le site Web GitHub. Pour afficher les noms distants de votre dĂ©pĂŽt et leur emplacement, tapez git remote -vLe nom « origine » est arbitraire. Vous pouvez le renommer en "github" si vous le souhaitez, mais nous ne le ferons pas maintenant.
  • "Rien Ă  valider / nettoyer le rĂ©pertoire de travail" signifie que vous ĂȘtes complĂštement Ă  jour et que vous n'avez apportĂ© aucune modification.

Capture d'Ă©cran : comment utiliser le statut git

Construire le site 18F

Allons-y et préparons-nous à créer le site.

  • Vous pouvez le faire en tapant ./go init.

Cette commande exĂ©cute un ensemble de commandes en arriĂšre-plan dont vous n'avez pas Ă  vous soucier. Il s'agit de tĂ©lĂ©charger et d'installer quelques Ă©lĂ©ments appelĂ©s « gemmes ». Les gemmes sont de petits ensembles de programmes Ă©crits dans le langage de programmation Ruby qui font des choses vraiment spĂ©cifiques. Jekyll est un joyau que nous utilisons pour crĂ©er le site Web 18f.gsa.gov, et notre version de celui-ci doit utiliser quelques autres joyaux pour fonctionner et faire fonctionner le site. La derniĂšre chose qu'il fait est de crĂ©er le site pour vous. Vous ne devriez avoir besoin de le faire qu'une seule fois.

"Construire" le site est un processus oĂč Jekyll prend toutes les informations du rĂ©pertoire 18f.gsa.gov et crĂ©e des pages Web dans un rĂ©pertoire appelĂ© _siteSi vous souhaitez simplement crĂ©er le site, tapez ./go build.

  • Pour voir Ă  quoi ressemble le site, vous pouvez taper ./go serve.

Cette commande "construit" le site et vous donne une adresse oĂč vous pouvez le visiter pour voir les modifications que vous avez apportĂ©es. Il devrait ĂȘtre 127.0.0.1:4000, ou http://localhost:4000pour faire court. Vous pouvez copier et coller cela directement dans un navigateur pour vĂ©rifier. Pour arrĂȘter le serveur, appuyez sur CTRL + C. Si vous essayez de visiter http://localhost:4000aprĂšs avoir appuyĂ© sur CTRL + C, vous ne verrez rien.

Toutes nos fĂ©licitations! Beaucoup des Ă©tapes que vous venez de faire sont des Ă©tapes uniques. Vous n'avez qu'Ă  exĂ©cuter le laptopscript une seule fois. Vous n'avez qu'Ă  cloner le dĂ©pĂŽt une seule fois. Et vous n'avez besoin de courir ./go initqu'une seule fois. Je voulais juste garder le moral. En avant!

Créer une branche

D'accord. Vous ĂȘtes maintenant prĂȘt Ă  commencer l'Ă©dition.

  • Ouvrez un Ă©diteur de texte adaptĂ© au dĂ©veloppement Web. Nous utilisons Sublime Text 3 , mais il existe d'autres options comme Atom ou vim, mais nous ne recommandons pas TextEdit ou un traitement de texte.

  • Cliquez maintenant sur Fichier -> Ouvrir dans la barre de menus et recherchez votre copie de 18f.gsa.gov, qui se trouve dans le rĂ©pertoire user/codeoĂč userse trouve votre nom d'utilisateur.

  • Cliquez sur 18f.gsa.gov et cliquez sur "ouvrir".

Voila ! Vous pouvez maintenant voir tous les fichiers qui composent le site. Ă‡a devrait ressembler Ă  ça.

Capture d'Ă©cran : Tous les fichiers qui composent le site 18F

Nous souhaitons maintenant crĂ©er une branche ou un bac Ă  sable oĂč vous pourrez apporter des modifications au site Web. Dans cette Ă©quipe, nous travaillons toujours sur les branches. Cela vous permet de collaborer avec des coĂ©quipiers sans interfĂ©rer avec le travail existant d'autres personnes.

  • Pour crĂ©er une nouvelle branche, tapez git checkout -b your-branch-name(Le nom de la branche peut ĂȘtre n'importe quoi mais il doit ĂȘtre descriptif.)

La commande git checkoutindique gitde travailler sur une branche diffĂ©rente. Le -b <branch-name>lui dit de crĂ©er la branche si elle n'existe pas encore. Vous pouvez changer de branche en tapant git checkout branch-nameEssayez de basculer entre la branche que vous venez de crĂ©er et stagingvoyez comment cela fonctionne.

  • Tapez git statuspour vous assurer que vous ĂȘtes maintenant sur la branche. Vous devriez voir quelque chose qui ressemble Ă  ceci :

Capture d'Ă©cran : git checkout et statut

Modifier et valider un article de blog

Nous allons maintenant vous guider dans la création d'un nouveau billet de blog pour 18f.gsa.gov.

  • Tapez ls -1Fpour voir une liste des fichiers et des dossiers qui composent le dĂ©pĂŽt de 18f.gsa.gov.

capture d'Ă©cran : commande ls -F

  • Retournez Ă  Sublime Text et rĂ©digez votre message. Enregistrez ensuite votre message dans le _postsrĂ©pertoire avec le nom 2015-02-23-new_post.mdoĂč '2015-02-23' est la date d'aujourd'hui.

Capture d'Ă©cran : Enregistrement d'un message dans le rĂ©pertoire _posts

Ajout d'avant-propos

L'Ă©tape suivante consiste Ă  ajouter ce qu'on appelle la matiĂšre avant. Il s'agit de mĂ©tadonnĂ©es pour l'article de blog : des informations supplĂ©mentaires que Jekyll utilise pour crĂ©er des parties du site Web. Il comprend des Ă©lĂ©ments tels que le titre, les auteurs, la description et la date. Vous ajoutez un avant-propos en collant dans les champs suivants Ă  partir de la ligne 1 de votre Ă©diteur de texte :

---
title: "How the 18F website team uses GitHub: a tutorial"
layout: post
author:
- melody
- boone
tags:
- GitHub
- Tutorial
- How We Work
excerpt: "This is a guide that assumes you have no prior knowledge of GitHub or the command line. We're going to introduce you to both GitHub and using the command line through a guided exercise. Today you'll learn how to make a blog post on the 18F blog."
description: "This is a guide that assumes you have no prior knowledge of GitHub or the command line. We're going to introduce you to both GitHub and using the command line through a guided exercise. Today you'll learn how to make a blog post on the 18F blog."
image: /assets/blog/how-to-github/image.jpg
---

Une explication complĂšte de l'avant-matiĂšre peut ĂȘtre trouvĂ©e sur le 18F Blogging Guide. Et maintenant, vous pouvez commencer Ă  Ă©crire le texte de votre article de blog Ă  la ligne 16. Dites bonjour ! Ă‡a devrait ressembler Ă  ça:

Capture d'Ă©cran : Ajout de Front Matter et enregistrement de la publication

  • Lorsque vous avez terminĂ© d'Ă©crire, enregistrez le message en appuyant sur Commande + S.

  • Et puis retournez au Terminal.

(Ne vous inquiétez pas. Vous avez presque terminé.)

Apprendre Ă  faire une pull request

  • Tapez git statusĂ  nouveau.

Vous remarquerez que cela git statusaffiche une nouvelle section pour les "fichiers non suivis" suivi du nom de votre article de blog. Git comporte quatre Ă©tapes dans lesquelles un fichier peut se trouver : non suivi, modifiĂ©, mis en scĂšne et validĂ©. Non suivi signifie que git n'en sait rien et ne surveillera pas vos modifications. Votre message n'est actuellement pas suivi et nous sommes sur le point de dĂ©placer le fichier Ă  travers les quatre Ă©tapes jusqu'Ă  ce qu'il soit « engagĂ© ».

  • Tapez git add _posts/2015-02-23-new-post.mdet appuyez sur EntrĂ©e. Assurez-vous de saisir votre nom de fichier rĂ©el s'il a une date diffĂ©rente.

Cela dĂ©place le fichier de non suivi Ă  mis en scĂšne. Vous venez de dire gitde se souvenir des modifications que vous avez apportĂ©es Ă  ce fichier. Si vous apportez d'autres modifications, le fichier sera "modifiĂ©" et vous devrez exĂ©cuter Ă  nouveau cette commande.

  • Tapez git statusĂ  nouveau.

Vous verrez que le fichier est maintenant répertorié sous les modifications à valider.

Capture d'Ă©cran : Git Add Post / Status

Bien jouĂ©! Ă€ ce stade, vous avez dit Ă  Git que ce fichier devrait ĂȘtre validĂ©, mais vous n'avez rien validĂ©. Vous pouvez donc travailler sur d'autres choses qui doivent ĂȘtre validĂ©es, ou vous pouvez valider ce fichier dĂšs maintenant. Nous allons nous engager dĂšs maintenant.

  • Taper git commit -m "My First Post"suivi de enter

Vous verrez quelque chose qui ressemble Ă  ceci

[melody-kramer-post 0b22894] My First Post
1 file changed, 7 insertions (+)
create mode 100644 _posts/2015-02-23-new-post.md

Cela signifie qu'un fichier a changĂ© - et c'Ă©tait votre article de blog ! FĂ©licitations, vous avez officiellement engagĂ© le fichier ! Vous ĂȘtes toujours au point oĂč vous seul pouvez voir ce fichier, mais il est maintenant officiellement enregistrĂ©. Vous avez enregistrĂ© le changement pour vous-mĂȘme et vous ĂȘtes prĂȘt Ă  suggĂ©rer le changement Ă  18F !

  • Tapez git statusune fois de plus.

Vous devriez voir nothing to commit, working directory cleanC'est parce que rien n'a changĂ© depuis le dernier commit.

Notez que la partie suivante fonctionnera un peu diffĂ©remment si vous n'ĂȘtes pas membre de l'Ă©quipe 18F et que vous travaillez Ă  partir d'un fork. Nous les incluons ici afin que vous puissiez voir ce qui se passe lorsque nous transfĂ©rons le fichier vers GitHub. Les instructions, telles qu'elles sont Ă©crites ici, fonctionneront pour n'importe quel dĂ©pĂŽt que vous possĂ©dez ou l'un de vos forks.

  • Tapez git push origin <branch>(oĂč <branch>est le nom que vous avez donnĂ© Ă  votre branche) puis appuyez sur EntrĂ©e.

Capture d'Ă©cran : git commit

Cela télécharge votre branche et passe au projet 18f.gsa.gov sur GitHub.

  • Maintenant, revenez Ă  18F sur GitHub et vous devriez voir que vous avez rĂ©cemment poussĂ© une branche.

Il ressemblera Ă  ceci:

Capture d'Ă©cran : Demande d'extraction

  • Cliquez sur Compare and Pull RequestC'est un gros bouton vert.

Vous pouvez ajouter un petit commentaire comme "J'ai Ă©crit un article de blog. N'est-ce pas la plus grande chose ? »

  • Cliquez ensuite sur Create Pull Request.

Capture d'Ă©cran : CrĂ©ation d'une demande d'extraction

Cela demande Ă  18F d'accepter votre contribution.

Capture d'Ă©cran : 18F recevant la contribution de l'utilisateur

Vous voulez toujours vous assurer que ce qui se trouve sur votre machine locale est aussi Ă  jour que possible. Ainsi, chaque fois que vous revenez au terminal, prenez l'habitude suivante :

  • Tapez git checkout stagingĂ  nouveau suivi de git pullpour vous assurer que votre version de la branche intermĂ©diaire est Ă  jour.

capture d'Ă©cran : paiement et extraction

Une fois que vous avez tapĂ©, git pulll'une des deux choses suivantes peut se produire :

  1. Il dira soit "C'est déjà à jour"
  2. Ou il commencera Ă  extraire des fichiers qui maintiendront votre ordinateur Ă  jour. Votre ordinateur tĂ©lĂ©charge uniquement les modifications entre votre ordinateur et GitHub.

Chaque fois que vous exĂ©cutez, git pullvous demandez Ă  GitHub de tĂ©lĂ©charger les modifications les plus rĂ©centes. Si vous recevez le premier message, cela signifie que rien n'a changĂ© depuis la derniĂšre fois que vous avez travaillĂ© dessus. Si vous obtenez la seconde, cela signifie que quelqu'un de l'Ă©quipe 18F a fusionnĂ© une autre pull request.

Une fois que vous ĂȘtes tous Ă  jour, n'oubliez pas de crĂ©er une nouvelle branche avant d'apporter de nouvelles modifications.

Si vous souhaitez apporter des mises Ă  jour Ă  ce guide ou suggĂ©rer des modifications, veuillez ajouter Ă  ce problĂšme et nous le vĂ©rifierons. Merci!

Moncef Belyamani a contribué de maniÚre significative à ce post, nous aidant à le façonner et à trouver nos erreurs.

Commentaires

Posts les plus consultés de ce blog

TOP outils de rĂ©fĂ©rencement gratuits qui valent la peine d'ĂȘtre utilisĂ©s en 2023

Les outils de rĂ©fĂ©rencement gratuits qui valent vraiment la peine d'ĂȘtre utilisĂ©s

Changement de domaine en 2023 : tout ce que vous devez savoir

Chatbot Dialogflow : Tutoriel NoCode NLP pour les spĂ©cialistes du marketing | Landbot

Revenu passif : idées pour gagner de l'argent (en dormant)

Meilleurs outils de rĂ©fĂ©rencement 🛠 organisĂ©e par Saijo George

La toolbox du growth hacker 💎 - Outils - Growthhacking.fr | CommunautĂ© française de growth hacking

Comment signer avec une maison de disques ? Voici notre guide ultime pour 2024

100 outils pour lancer sa startup sans argent (mais pas sans talent)