Affichage et compréhension des fichiers

GitHub fournit des outils permettant de visualiser le contenu brut, de suivre les modifications apportées à des lignes spécifiques et d'explorer l'évolution du contenu d'un fichier au fil du temps. Ces insights révèlent comment le code a été développé, son objectif actuel et sa structure, ce qui vous aide à contribuer efficacement.

Affichage ou copie du contenu d’un fichier brut

L’affichage brut vous permet d’afficher ou de copier le contenu brut d’un fichier sans aucun style.

1. Sur GitHub, accédez à la page principale du référentiel.

2. Cliquez sur le fichier que vous souhaitez afficher.

3. Dans le coin supérieur droit de l’affichage du fichier, cliquez sur Brut.

   

4. Si vous le souhaitez, pour copier le contenu du fichier brut, dans le coin supérieur droit de la vue du fichier, cliquez sur . Pour télécharger le fichier brut, cliquez sur .

Affichage de l’historique de révision ligne par ligne pour un fichier

Dans la vue du responsable, vous pouvez voir l’historique des révisions ligne par ligne d’un fichier entier.

1. Sur GitHub, accédez à la page principale du référentiel.

2. Cliquez pour ouvrir le fichier dont vous souhaitez afficher l’historique des lignes.

3. Au-dessus du contenu du fichier, cliquez sur Blâme. Ce mode vous permet d’accéder à un historique des révisions ligne par ligne, où le code se trouve dans un fichier séparé par commit. Chaque commit liste l’auteur, la description et la date du commit.

4. Pour voir les versions d’un fichier avant un commit particulier, cliquez sur . Sinon, pour voir plus de détails sur un commit en particulier, cliquez sur le message de commit.

   

5. Pour retourner au mode Code brut, au-dessus du contenu du fichier, cliquez sur Code.

   • Si vous visualisez un fichier Markdown, au-dessus du contenu du fichier, vous pouvez également cliquer sur Aperçu pour retourner à la vue où la mise en forme Markdown est appliquée.

Ignorer des commits dans l’affichage des blâmes

Toutes les révisions spécifiées dans le fichier .git-blame-ignore-revs, qui doit se trouver dans le répertoire racine de votre dépôt, sont masquées de l’affichage des blâmes à l’aide du paramètre de configuration Git git blame --ignore-revs-file. Pour plus d’informations, consultez git blame --ignore-revs-file dans la documentation Git.

1. Dans le répertoire racine de votre dépôt, créez un fichier nommé .git-blame-ignore-revs.

2. Ajoutez les hachages de commit que vous souhaitez exclure de l’affichage des blâmes pour ce fichier. Nous vous recommandons de structurer le fichier comme suit, y compris les commentaires :

   # .git-blame-ignore-revs
   # Removed semi-colons from the entire codebase
   a8940f7fbddf7fad9d7d50014d4e8d46baf30592
   # Converted all JavaScript to TypeScript
   69d029cec8337c616552756310748c4a507bd75a
   

3. Commitez et poussez (push) les changements.

Maintenant, lorsque vous visitez l’affichage des blâmes, les révisions listées ne sont pas incluses dans le blâme. Vous voyez la bannière Révisions dans .git-blame-ignore-revs ignorées qui indique que certains commits peuvent être masqués :

Cela peut être utile si quelques commits apportent des modifications importantes à votre code. Vous pouvez également utiliser le fichier lors de l’exécution locale de git blame :

git blame --ignore-revs-file .git-blame-ignore-revs

Vous pouvez également configurer votre dépôt Git local afin qu’il ignore toujours les révisions dans ce fichier :

git config blame.ignoreRevsFile .git-blame-ignore-revs

Contournement de .git-blame-ignore-revs dans l’affichage des blâmes

Si l’affichage des blâmes d’un fichier indique Révisions dans .git-blame-ignore-revs ignorées, vous pouvez toujours contourner .git-blame-ignore-revs et consulter l’affichage des blâmes normal. Dans l’URL, ajoutez un ~ au SHA et la bannière Ignorer les révisions dans .git-blame-ignore-revs disparaîtra.

Comprendre les fichiers avec Copilot

Vous pouvez également utiliser Copilot pour poser des questions sur des lignes de code spécifiques dans un fichier, ce qui vous aide à comprendre le fonctionnement du code et réduit le risque d'introduire de nouveaux problèmes.

1. Dans GitHub, accédez à un référentiel et ouvrez un fichier.

2. Effectuez l’une des opérations suivantes :

   • Pour poser une question sur l'ensemble du fichier, cliquez sur l'icône Copilot () en haut à droite de la vue du fichier.

     

   • Pour poser une question sur des lignes spécifiques du fichier :

     1. Cliquez sur le numéro de ligne de la première ligne que vous souhaitez interroger, maintenez la touche Majuscule enfoncée, puis cliquez sur le numéro de ligne de la dernière ligne que vous souhaitez sélectionner.
     2. Pour poser votre propre question sur les lignes sélectionnées, cliquez sur l'icône Copilot () à droite de votre sélection, puis tapez votre question dans le panneau GitHub Copilot Chat.
     3. Pour poser une question prédéfinie, cliquez sur le bouton pointant vers le bas à côté de l’icône de Copilot, puis choisissez l’une des options.
     

3. Si vous avez cliqué sur l’icône de Copilot, saisissez une question dans la zone Demander à Copilot en bas du volet de conversation, puis appuyez sur Entrée.

   Par exemple, si vous souhaitez poser des questions sur l’intégralité du fichier, vous pouvez entrer :

   • Explain this file.
   • How could I improve this code?
   • How can I test this script?

   Si vous souhaitez poser des questions sur des lignes spécifiques, vous pouvez entrer :

   • Explain the function at the selected lines.
   • How could I improve this class?
   • Add error handling to this code.
   • Write a unit test for this method.

   Copilot répond à votre demande dans le volet.

4. Si vous le souhaitez, cliquez sur dans la zone de texte pour empêcher Copilot de poursuivre sa réponse.

5. Vous pouvez poursuivre la conversation en posant une question de suivi. Par exemple, vous pouvez saisir « Dites-m’en plus » pour que Copilot développe son dernier commentaire.