Choisir le projet public et l’affirmation
Commencez par un dépôt public précis, qu’il s’agisse de votre propre projet ou d’une organisation que vous étudiez. Copiez son nom complet propriétaire/dépôt. Notez la formulation exacte de la fonctionnalité que vous cherchez à localiser, et distinguez la documentation d’un test de l’implémentation.
Utilisez cette procédure pour trouver de la documentation de projet. Ne recherchez pas d’identifiants exposés, d’informations de contact privées ou de moyens de contourner les contrôles d’accès aux dépôts.
Utiliser les qualificatifs de recherche de code à bon escient
La documentation de recherche de code de GitHub explique qu’un terme seul peut correspondre soit à un chemin de fichier, soit à son contenu. repo: limite la recherche à un nom complet propriétaire/dépôt, path: restreint les chemins et content: exige que le terme figure dans le corps du fichier. Les chaînes entre guillemets permettent de rechercher une formulation exacte. Ces règles s’appliquent à la recherche de code, pas automatiquement à la recherche d’issues ou de profils. Source
Pour un dépôt illustratif nommé example-owner/example-project, une requête pourrait être :
repo:example-owner/example-project content:"export format"Les noms et l’expression sont des exemples fictifs, pas une recherche réelle que nous avons effectuée. Remplacez-les par le dépôt que vous êtes autorisé à examiner et par la formulation pertinente pour votre question. Si vous savez que les fichiers se trouvent sous un chemin de documentation, ajoutez une restriction path: appropriée ; sinon, n’incluez pas cette hypothèse.
Interpréter la correspondance avant de la citer
| Résultat | Ce qu’il faut vérifier | Ce que cela ne prouve pas |
|---|---|---|
| Nom de fichier correspondant | Si l’expression figure dans le corps | Que le fichier étaye l’affirmation |
| Passage de documentation | Les mentions de version et de fonctionnalité à proximité | Que la fonctionnalité décrite a été testée |
| Exemple ou proposition | S’il décrit un comportement prévu ou illustratif | Que la fonctionnalité est publiée |
| Résultat vide | Le dépôt, le type de requête et les restrictions | Que l’affirmation n’a jamais existé nulle part |
GitHub documente une exigence de connexion pour la recherche de code dans tous les dépôts publics. Il distingue également un site GitHub Pages du contenu source du dépôt. Source Notez la surface de recherche réelle et les limites d’accès ; ne contournez pas une restriction de connexion et ne considérez pas un site non recherché comme couvert.
Lier le passage à une version
Ouvrez le fichier et lisez la section pertinente dans son intégralité. Attribuez une affirmation documentée au projet. N’exécutez pas le code du dépôt uniquement pour mener à bien cette lecture, et n’inférez pas la fiabilité d’un produit à partir des étoiles ou des noms de compte.
Une fois le bon passage localisé, suivez le guide des permaliens GitHub pour conserver la version inspectée. La checklist de vérification des sources assistée par IA aide ensuite à distinguer la déclaration de ce document des conclusions ajoutées par le modèle.