Scegli il passaggio che devi supportare
Supponi di verificare un’istruzione di installazione nel README pubblico del tuo progetto prima di menzionarla in un articolo. Individua il passaggio esatto e le condizioni vicine. Il titolo di un repository o la biografia di un profilo non sostituiscono il file che contiene l’affermazione.
Mantieni il compito limitato al documento. Non è necessario eseguire il progetto, ispezionare informazioni di contatto personali o trattare l’account di un collaboratore come prova di un’identità privata.
Sostituisci la vista del branch che cambia con un link alla versione
GitHub spiega che la visualizzazione ordinaria di un file mostra di solito l’head corrente di un branch, quindi il suo contenuto può cambiare con l’arrivo di nuovi commit. Mentre visualizzi il file, premere y cambia l’URL in un permalink che usa un commit specifico invece del nome del branch. Fonte
Copia l’URL effettivamente visualizzato dopo quell’azione. Riaprilo e verifica che mostri lo stesso file e lo stesso passaggio. Non inventare un identificatore di commit né costruire una citazione da un’anteprima di ricerca che non hai aperto.
Conserva una nota separata se vuoi anche l’indirizzo del branch corrente. Il link alla versione risponde alla domanda «quale formulazione ho esaminato?», mentre la vista del branch ti permette di controllare cosa presenta ora il progetto.
Registra un contesto sufficiente per un altro lettore
| Campo | Registra dalla tua ispezione | Scopo |
|---|---|---|
| Repository e file | Il progetto e il percorso del file effettivi | Identificare il documento citato |
| Identificatore di commit | La versione nel permalink copiato | Distinguere questa istantanea da modifiche successive |
| Passaggio di supporto | Un breve estratto o un riassunto fedele | Limitare l’affermazione alla formulazione esaminata |
| Condizioni vicine | Versione, ambiente o limiti della funzionalità | Evitare di omettere una qualificazione |
| Data di accesso | Quando hai aperto la fonte | Separare il momento della tua revisione dalla storia della pubblicazione |
Per un README illustrativo che dice che una funzione di esportazione è sperimentale, l’affermazione supportata mantiene «sperimentale». Un URL stabile non giustifica riscriverla come una garanzia testata. Questo esempio illustra la pratica della citazione; non è un resoconto su un repository reale.
Decidi se un’affermazione vecchia è ancora rilevante
Se il branch corrente è diverso, conserva entrambe le osservazioni: la versione precedente che hai citato e la formulazione attuale che hai effettivamente aperto. Non sostituire silenziosamente una citazione più vecchia continuando a descriverla come la stessa revisione.
Un file può contenere piani, esempi o istruzioni obsolete. Attribuisci quelle affermazioni al progetto invece di dichiarare di aver testato personalmente l’implementazione. Se in seguito l’accesso fallisce, registra quel limite; un identificatore di versione non è una promessa di hosting permanente o di autorizzazione.
Questo è anche distinto da un badge di commit firmato. La guida al badge Verified di GitHub affronta quel diverso segnale. Per una sintesi più ampia dei documenti pubblici, usa la checklist di revisione delle fonti con l’AI e conserva la versione esatta su cui si basa ogni affermazione materiale.