Выберите публичный проект и утверждение
Начните с конкретного публичного репозитория — вашего собственного проекта или организации, которую вы изучаете. Скопируйте полное имя владельца и репозитория. Сформулируйте точное утверждение о функциональности, которое нужно найти, и отличайте документацию от проверки реализации.
Используйте эту процедуру для поиска документации проекта. Не ищите открытые учётные данные, личную контактную информацию или способы обойти контроль доступа к репозиторию.
Осознанно используйте уточнения поиска по коду
Документация GitHub по поиску кода объясняет, что отдельный термин может совпасть как с путём к файлу, так и с его содержимым. repo: ограничивает поиск полным именем владельца и репозитория, path: сужает пути, а content: требует наличия термина в теле файла. Строки в кавычках позволяют искать точную формулировку. Эти правила относятся к поиску по коду и не распространяются автоматически на поиск по issues или профилям. Источник
Для иллюстративного репозитория с именем example-owner/example-project запрос может выглядеть так:
repo:example-owner/example-project content:"export format"Имена и фраза здесь — заполнители, а не реальный выполненный нами поиск. Подставьте репозиторий, который вам разрешено просматривать, и формулировку, относящуюся к вашему вопросу. Если вы знаете, что файлы находятся в каталоге документации, добавьте подходящее ограничение path:; в противном случае не делайте такого предположения.
Интерпретируйте совпадение, прежде чем цитировать его
| Результат | Что проверить | Чего он не доказывает |
|---|---|---|
| Совпадение в имени файла | Встречается ли фраза в теле файла | Что файл подтверждает утверждение |
| Фрагмент документации | Близкие по тексту оговорки о версии и функциональности | Что описанная функция была протестирована |
| Пример или предложение | Описывает ли он планируемое или иллюстративное поведение | Что функциональность выпущена |
| Пустой результат | Репозиторий, тип запроса и ограничения | Что утверждения никогда нигде не существовало |
GitHub документирует требование входа в систему для поиска по коду во всех публичных репозиториях. Он также отличает сайт GitHub Pages от исходного содержимого репозитория. Источник Зафиксируйте фактическую область поиска и ограничения доступа; не обходите требование входа и не считайте непроверенный сайт охваченным.
Привяжите фрагмент к версии
Откройте файл и прочитайте соответствующий раздел полностью. Приписывайте документированное утверждение проекту. Не запускайте код из репозитория только ради этой задачи чтения и не делайте выводов о надёжности продукта по звёздам или именам аккаунтов.
Когда нужный фрагмент найден, следуйте руководству по постоянным ссылкам GitHub, чтобы сохранить просмотренную версию. Затем чек-лист по проверке источников для ИИ поможет отделить утверждение из документа от выводов, которые добавила модель.