選擇公開項目與待查主張
先從你自己項目或你正在研究的組織中,選定一個具體的公開儲存庫。複製其完整的擁有者及儲存庫名稱。寫下你需要定位的確切功能聲明,並區分文件說明與對實作進行的測試。
使用此程序尋找項目文件。請勿搜尋外洩憑證、私人聯絡資料或繞過儲存庫存取控制的方法。
審慎使用程式碼搜尋限定詞
GitHub 的程式碼搜尋文件說明,單獨的詞語可能同時符合檔案路徑或檔案內容。repo: 將搜尋限定於完整的擁有者/儲存庫名稱,path: 縮窄路徑範圍,content: 則要求詞語必須出現於檔案正文。引號字串可搜尋確切措辭。這些規則適用於程式碼搜尋,並不自動適用於議題或個人檔案搜尋。來源
以一個名為 example-owner/example-project 的示範儲存庫為例,查詢可以是:
repo:example-owner/example-project content:"export format"
上述名稱與短語均為佔位符,並非我們實際執行過的搜尋。請替換成你獲授權審查的儲存庫,以及與你問題相關的措辭。若你已知檔案位於文件路徑之下,可加入合適的 path: 限制;否則不要加入這項假設。
在引用前先解讀相符結果
| 結果 | 應檢查什麼 | 不能證明什麼 |
|---|---|---|
| 檔名相符 | 短語是否出現於正文 | 該檔案支持此聲明 |
| 文件段落 | 鄰近的版本與功能限定條件 | 所述功能已經過測試 |
| 範例或提案 | 它描述的是計劃中還是示範性質的行為 | 該功能已經發布 |
| 空結果 | 儲存庫、查詢類型及限制條件 | 該主張從未在任何地方存在 |
GitHub 文件說明,對所有公開儲存庫進行程式碼搜尋需要登入。文件亦區分 GitHub Pages 網站與儲存庫原始碼內容。來源 記錄實際的搜尋範圍與存取限制;不要繞過登入限制,也不要將未搜尋的網站視為已涵蓋。
讓段落與版本保持對應
開啟檔案並閱讀完整的相關章節。將有文件記載的主張歸屬於該項目。不要為了完成這項閱讀任務而執行儲存庫程式碼,也不要從星號數或帳戶名稱推斷產品可靠性。
找到正確段落後,依照 GitHub 永久連結指南 保留所檢查的版本。AI 來源審查清單 則有助區分該文件的聲明與模型自行添加的結論。