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