Виберіть публічний проєкт і твердження
Почніть із конкретного публічного репозиторію — вашого власного проєкту або організації, яку ви досліджуєте. Скопіюйте повне ім’я власника та репозиторію. Сформулюйте точне твердження про функцію, яке потрібно знайти, і відрізняйте документацію від перевірки реалізації.
Використовуйте цю процедуру для пошуку документації проєкту. Не шукайте відкриті облікові дані, приватну контактну інформацію чи способи обійти контроль доступу до репозиторію.
Використовуйте уточнення пошуку коду свідомо
Документація GitHub щодо пошуку коду пояснює, що окремий термін може збігатися як із шляхом до файлу, так і з його вмістом. repo: обмежує пошук повним ім’ям owner/repository, path: звужує шляхи, а content: вимагає наявності терміна в тілі файлу. Рядки в лапках шукають точне формулювання. Ці правила стосуються пошуку коду, а не автоматично питань (issues) чи пошуку профілів. Джерело
Для ілюстративного репозиторію з назвою example-owner/example-project запит може бути таким:
repo:example-owner/example-project content:"export format"Назви та фраза є заповнювачами, а не реальним пошуком, який ми виконували. Підставте репозиторій, який вам дозволено переглядати, і формулювання, що відповідає вашому питанню. Якщо ви знаєте, що файли лежать у теці документації, додайте відповідне обмеження path:; інакше не робіть такого припущення.
Інтерпретуйте збіг, перш ніж цитувати його
| Результат | Що перевірити | Чого це не доводить |
|---|---|---|
| Збіг назви файлу | Чи трапляється фраза в тілі | Що файл підтверджує твердження |
| Уривок документації | Наявні поруч застереження щодо версії та функції | Що описану функцію перевірено |
| Приклад або пропозиція | Чи описує він заплановану або ілюстративну поведінку | Що функціональність випущено |
| Порожній результат | Репозиторій, тип запиту та обмеження | Що твердження ніколи ніде не існувало |
GitHub документує вимогу входу для пошуку коду в усіх публічних репозиторіях. Він також відрізняє вебсайт GitHub Pages від вмісту вихідного коду репозиторію. Джерело Зафіксуйте фактичну поверхню пошуку та обмеження доступу; не обходьте вимогу входу і не вважайте непереглянутий вебсайт охопленим.
Прив’яжіть уривок до версії
Відкрийте файл і прочитайте повний відповідний розділ. Приписуйте задокументоване твердження проєкту. Не виконуйте код репозиторію лише для завершення цього завдання читання і не робіть висновків про надійність продукту з зірок або назв облікових записів.
Коли правильний уривок знайдено, скористайтеся посібником із постійних посилань GitHub, щоб зберегти переглянуту версію. Далі контрольний список перевірки джерел для ШІ допомагає відокремити твердження цього документа від висновків, які додала модель.