Виберіть уривок, який потрібно підтвердити
Припустімо, ви перевіряєте твердження про встановлення у публічному README вашого власного проєкту, перш ніж згадати його в статті. Знайдіть точний уривок і умови поруч із ним. Назва репозиторію або біографія профілю не замінюють файл, що містить твердження.
Обмежте завдання документом. Вам не потрібно запускати проєкт, перевіряти особисту контактну інформацію або вважати обліковий запис учасника доказом приватної особи.
Замініть мінливий перегляд гілки посиланням на версію
GitHub пояснює, що звичайний перегляд файлу зазвичай показує поточний head гілки, тому його вміст може змінюватися в міру надходження комітів. Під час перегляду файлу натискання y змінює URL на permalink, який використовує конкретний коміт замість назви гілки. Джерело
Скопіюйте URL, який фактично відображається після цієї дії. Відкрийте його знову й переконайтеся, що він показує той самий файл і уривок. Не вигадуйте ідентифікатор коміту й не створюйте цитату з пошукового прев’ю, яке ви не відкривали.
Зробіть окрему нотатку, якщо вам також потрібна адреса поточної гілки. Посилання на версію відповідає на запитання «яке формулювання я переглянув?», тоді як перегляд гілки дає змогу перевірити, що проєкт подає зараз.
Запишіть достатньо контексту для іншого читача
| Поле | Запишіть зі свого перегляду | Призначення |
|---|---|---|
| Репозиторій і файл | Фактичний проєкт і шлях до файлу | Ідентифікувати документ, на який посилаєтеся |
| Ідентифікатор коміту | Версія в скопійованому permalink | Відрізнити цей знімок від пізніших редагувань |
| Підтверджувальний уривок | Короткий фрагмент або точний переказ | Обмежити твердження переглянутим формулюванням |
| Умови поруч | Версія, середовище або обмеження функції | Не відкинути застереження |
| Дата доступу | Коли ви відкрили джерело | Відокремити час вашого перегляду від історії публікації |
Для ілюстративного README, де сказано, що функція експорту є експериментальною, підтверджене твердження зберігає слово «експериментальна». Стабільний URL не дає підстав переписувати його як перевірену гарантію. Цей приклад ілюструє практику цитування; це не звіт про реальний репозиторій.
Вирішіть, чи старе твердження все ще актуальне
Якщо поточна гілка відрізняється, збережіть обидва спостереження: попередню версію, яку ви цитували, і поточне формулювання, яке ви фактично відкрили. Не замінюйте мовчки старішу цитату, продовжуючи описувати її як той самий перегляд.
Файл може містити плани, приклади або застарілі інструкції. Приписуйте ці твердження проєкту, а не стверджуйте, що ви самостійно перевірили реалізацію. Якщо доступ згодом зникне, зафіксуйте це обмеження; ідентифікатор версії не є обіцянкою постійного хостингу чи дозволу.
Це також відрізняється від значка підписаного коміту. Посібник GitHub про значок Verified розглядає цей інший сигнал. Для ширшого синтезу публічних документів скористайтеся контрольним списком перевірки джерел за допомогою AI і зберігайте точну версію, на яку спирається кожне суттєве твердження.