Kies de passage die je wilt onderbouwen
Stel dat je een installatieverklaring in de openbare README van je eigen project controleert voordat je die in een artikel noemt. Zoek de exacte passage en de voorwaarden in de buurt ervan. Een repositorytitel of profielbiografie vervangt niet het bestand met de verklaring.
Beperk de taak tot het document. Je hoeft het project niet uit te voeren, persoonlijke contactgegevens niet te inspecteren en het account van een bijdrager niet als bewijs van een privé-identiteit te behandelen.
Vervang de veranderende branchweergave door een versielink
GitHub legt uit dat een gewone bestandsweergave meestal de huidige head van een branch toont, zodat de inhoud kan veranderen naarmate er commits binnenkomen. Terwijl je het bestand bekijkt, verandert het indrukken van y de URL in een permalink die een specifieke commit gebruikt in plaats van de branchnaam. Bron
Kopieer de URL die daadwerkelijk wordt weergegeven na die actie. Open hem opnieuw en bevestig dat hij hetzelfde bestand en dezelfde passage toont. Verzin geen commit-identificatie en stel geen citaat samen uit een zoekvoorbeeld dat je niet hebt geopend.
Bewaar een aparte notitie als je ook het huidige branchadres wilt. De versielink beantwoordt de vraag ‘welke formulering heb ik bekeken?’, terwijl de branchweergave je laat controleren wat het project nu presenteert.
Leg voldoende context vast voor een andere lezer
| Veld | Vastleggen uit je inspectie | Doel |
|---|---|---|
| Repository en bestand | Het werkelijke project en het bestandspad | Het document identificeren waarnaar je verwijst |
| Commit-identificatie | De versie in de gekopieerde permalink | Deze momentopname onderscheiden van latere bewerkingen |
| Ondersteunende passage | Een kort fragment of een getrouwe samenvatting | De claim beperken tot de geïnspecteerde formulering |
| Voorwaarden in de buurt | Versie, omgeving of functiebeperkingen | Een voorbehoud niet weglaten |
| Toegangsdatum | Wanneer je de bron hebt geopend | Je beoordelingstijd scheiden van de publicatiegeschiedenis |
Voor een illustratieve README die zegt dat een exportfunctie experimenteel is, behoudt de onderbouwde verklaring ‘experimenteel’. Een stabiele URL rechtvaardigt niet dat je dit herschrijft als een geteste garantie. Dit voorbeeld illustreert de citatiepraktijk; het is geen verslag over een echte repository.
Bepaal of een oude verklaring nog relevant is
Als de huidige branch afwijkt, bewaar dan beide observaties: de eerdere versie waarnaar je verwees en de huidige formulering die je daadwerkelijk hebt geopend. Vervang een ouder citaat niet stilzwijgend terwijl je het blijft beschrijven als dezelfde beoordeling.
Een bestand kan plannen, voorbeelden of verouderde instructies bevatten. Schrijf die verklaringen toe aan het project in plaats van te beweren dat je de implementatie zelfstandig hebt getest. Als toegang later mislukt, leg die beperking dan vast; een versie-identificatie is geen belofte van permanente hosting of toestemming.
Dit staat ook los van een badge voor ondertekende commits. De GitHub Verified-badge gids behandelt dat andere signaal. Voor een bredere synthese van openbare documenten gebruik je de AI-bronbeoordelingschecklist en bewaar je de exacte versie waarop elke materiële claim berust.