RepoProof
從新使用者的角度證明儲存庫。將 README 視為一份合約,而非建議。
預設工作流程
- 執行
node scripts/repoproof.mjs audit . --output repoproof-output。 - 在下結論之前,先讀取
repoproof-output/repoproof-report.json。 - 如果使用者明確允許執行,則執行
node scripts/repoproof.mjs prove . --allow-exec --output repoproof-output。 - 如果需要修復,執行
node scripts/repoproof.mjs fix . --dry-run --output repoproof-output並檢查repoproof-fixes.patch。 - 只報告證據支持的內容。將未經證實的主張標記為「未證實」。
安全規則
- 稽核模式是預設模式,且不得執行儲存庫程式碼。
- 證明模式需要使用者明確批准(使用
--allow-exec或 CI 執行器)。 - 絕不發布、部署、推送、合併或讀取使用者機密。
- 如果沒有真實的容器、虛擬機器或作業系統沙箱,絕不宣稱具備強大的沙箱隔離能力。
- 使用確定性腳本來收集證據並進行去敏處理。
參考資料
- 閱讀
references/workflow.md以了解完整的稽核/證明/修復工作流程。 - 在執行儲存庫程式碼之前,閱讀
references/safety-model.md。 - 當 README 步驟提取不明確時,閱讀
references/extraction-rules.md。 - 在提出編輯建議之前,閱讀
references/fix-policy.md。 - 在解讀報告時,閱讀
references/evidence-schema.md。 - 在新增 CI 之前,閱讀
references/github-action.md。 - 閱讀
references/platform-notes.md以了解 Windows、macOS 和 Linux 的差異。